Reference
API reference
Generated public API inventory for every published Fabric Harness entrypoint.
This reference is generated from the declaration files shipped in each package. Import from the
entrypoint shown in the table; symbols marked type are TypeScript-only exports.
@fabric-harness/agent-boundary
@fabric-harness/agent-boundary
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
AgentRunBounds | type | { maxWallTimeMs: number; maxTurns: number; maxToolCalls: number; maxExternalCalls: number; maxConcurrentToolCalls: number; maxRunTokens: number; maxCostUsd: number; } | Type contract for agent run bounds. |
agentRunBoundsSchema | value | z.ZodObject<{ maxWallTimeMs: z.ZodNumber; maxTurns: z.ZodNumber; maxToolCalls: z.ZodNumber; maxExternalCalls: z.ZodNumber; maxConcurrentToolCalls: z.ZodNumber; maxRunTokens: z.ZodNumber; maxCostUsd: z.ZodNumber; }, z.core.$strip> | The complete per-run bound set (collaboration plan D10). Every consuming boundary — MCP tool calls, the ACP/process path, and the model/provider path — enforces from this one shape; no path may carry a looser private subset. |
AgentRunBudgetStore | type | AgentRunBudgetStore | Durable, per-run budget state (collaboration plan D10: budget state is per enrollment/run, durable, and audited). Implementations must make consume atomic — two concurrent consumers must not both fit through the last slot of a bound — and must persist revocation so a restarted process cannot resume a revoked run. |
AgentRunUsage | type | { turns: number; toolCalls: number; externalCalls: number; usedTokens: number; usedCostUsd: number; } | Type contract for agent run usage. |
AgentRunUsageDelta | type | AgentRunUsageDelta | Incremental usage to charge against a run's bounds. |
agentRunUsageSchema | value | z.ZodObject<{ turns: z.ZodNumber; toolCalls: z.ZodNumber; externalCalls: z.ZodNumber; usedTokens: z.ZodNumber; usedCostUsd: z.ZodNumber; }, z.core.$strip> | Cumulative usage recorded against AgentRunBounds. |
BoundaryAuditEvent | type | { type: "run-started"; runId: string; enrollmentId: string; tenantId: string; at: string; } | { type: "bound-exhausted"; runId: string; bound: "turns" | "wall-time" | "tool-calls" | "external-calls" | "concurrency" | "tokens" | "cost"; usage: { turns... | Type contract for boundary audit event. |
boundaryAuditEventSchema | value | z.ZodDiscriminatedUnion<[z.ZodObject<{ type: z.ZodLiteral<"run-started">; runId: z.ZodString; enrollmentId: z.ZodString; tenantId: z.ZodString; at: z.ZodString; }, z.core.$strip>, z.ZodObject<{ type: z.ZodLiteral<"bound-exhausted">; runId... | Audit vocabulary for the execution boundary. Every bound exhaustion, refusal, cancellation, revocation, and process termination is recorded — an unaudited stop is a gate failure (collaboration plan D10). |
BoundaryAuditSink | type | BoundaryAuditSink | Where boundary audit events go. Verticals bind this to their audit log. |
BoundaryRefusal | value | typeof BoundaryRefusal | A refusal is a terminal answer for the refused unit of work, never a retry hint. Exhaustion refusals also stop the run itself (the governor aborts), so later model or tool work cannot proceed. |
BoundaryRefusalCode | type | BoundaryRefusalCode | Refusal vocabulary for the governed execution boundary (collaboration plan D10). Every refusal names the exhausted or violated bound; callers must not invent codes outside this union. |
BoundaryToolDefinition | type | BoundaryToolDefinition | Type contract for boundary tool definition. |
ConsumeResult | type | ConsumeResult | Result returned by consume. |
createRunGovernor | value | (options: RunGovernorOptions) => Promise<RunGovernor> | Creates run governor. |
createToolBoundary | value | (options: ToolBoundaryOptions) => ToolBoundary | Build the per-run tool surface. Every call is governed: active-run check, tool-call/external-call/concurrency metering, zod validation, and — for proposal tools — submission through the governed proposal port only. |
decideConsume | value | (usage: AgentRunUsage, delta: AgentRunUsageDelta, bounds: AgentRunBounds) => ConsumeResult | Shared decision core for store implementations (pure). |
defineProposalTool | value | <TInput extends z.ZodType>(tool: Omit<ProposalToolDefinition<TInput>, "kind">) => ProposalToolDefinition<TInput> | Defines proposal tool. |
defineReadTool | value | <TInput extends z.ZodType>(tool: Omit<ReadToolDefinition<TInput>, "kind">) => ReadToolDefinition<TInput> | Defines read tool. |
emptyAgentRunUsage | value | { turns: number; toolCalls: number; externalCalls: number; usedTokens: number; usedCostUsd: number; } | Runtime API for empty agent run usage; the generated signature shows its accepted inputs and return type. |
ExhaustedBound | type | ExhaustedBound | Type contract for exhausted bound. |
GuardedModelRequest | type | GuardedModelRequest | Input contract for guarded model. |
GuardedModelResponse | type | GuardedModelResponse | Response contract for guarded model. |
guardModelProvider | value | <TRequest extends GuardedModelRequest, TResponse extends GuardedModelResponse>(options: GuardModelProviderOptions<TRequest, TResponse>) => (request: TRequest) => Promise<TResponse> | Model/provider-path enforcement (collaboration plan D10): the budget is checked before the provider is invoked, each request is clamped to the policy's per-request output cap, actual usage is recorded immediately after the response, and the run's abort signal reaches the provider call. A run that exhausts its budget cannot start another model turn — stopping is not deferred until a later tool call. |
GuardModelProviderOptions | type | GuardModelProviderOptions<TRequest, TResponse> | Configuration options for guard model provider. |
inMemoryAgentRunBudgetStore | value | () => AgentRunBudgetStore | In-memory reference implementation. Suitable for tests and single-process development runners; production deployments bind a store backed by their durable database. |
inMemoryBoundaryAuditSink | value | () => BoundaryAuditSink & { events: BoundaryAuditEvent[]; } | Test/development sink retaining every event in order. |
isBoundaryRefusal | value | (error: unknown) => error is BoundaryRefusal | Checks whether a value is boundary refusal. |
McpBoundaryServer | type | McpBoundaryServer | Type contract for mcp boundary server. |
McpBoundaryServerOptions | type | McpBoundaryServerOptions | Configuration options for mcp boundary server. |
ProposalToolDefinition | type | ProposalToolDefinition<TInput> | A proposal tool: the only write shape an agent has. It maps validated params to a governed action proposal — the boundary submits through the vertical's GovernedProposalPort and nothing else. The tool itself performs no effect. |
ReadToolDefinition | type | ReadToolDefinition<TInput> | A read tool: answers from the vertical's authorized projections. Never mutates. external marks reads that leave the deployment boundary (they are metered against maxExternalCalls). |
resolveRunBounds | value | (policy: AgentVersion["modelPolicy"], options: ResolveRunBoundsOptions) => AgentRunBounds | Derive the run bounds from an immutable agent version's modelPolicy (token/cost budgets come from the registry contract verbatim) plus the execution-shape bounds the enrolling surface supplies. |
ResolveRunBoundsOptions | type | ResolveRunBoundsOptions | Configuration options for resolve run bounds. |
RunGovernor | type | RunGovernor | The per-run enforcement core (collaboration plan D10). One governor guards every consuming boundary of a run: MCP tool calls, the model/provider path, and the supervised process. Exhaustion, cancellation, and revocation all abort the shared signal so in-flight work stops — a stop is never deferred until the next tool call. |
RunGovernorOptions | type | RunGovernorOptions | Configuration options for run governor. |
serveMcpBoundary | value | (options: McpBoundaryServerOptions) => Promise<McpBoundaryServer> | Serve a ToolBoundary over MCP. The listing is exactly the boundary's allowlist — a forbidden tool is absent, not refused — and every call flows through the run governor. When the governor stops (cancelled, revoked, exhausted, out of wall time) the transport is closed, so an agent mid-run loses the tool surface entirely (gate B2). |
superviseAgentProcess | value | (options: SuperviseProcessOptions) => SupervisedProcess | ACP/process-path enforcement (collaboration plan D10): the agent child process lives strictly inside its run's governor. Cancellation, revocation, wall-time expiry, and budget exhaustion all abort the governor's signal, which terminates the child (SIGTERM, then SIGKILL after the grace period). Termination is audited. |
SupervisedProcess | type | SupervisedProcess | Type contract for supervised process. |
SuperviseProcessOptions | type | SuperviseProcessOptions | Configuration options for supervise process. |
ToolBoundary | type | ToolBoundary | Type contract for tool boundary. |
ToolBoundaryOptions | type | ToolBoundaryOptions | Configuration options for tool boundary. |
ToolCallGuard | type | ToolCallGuard | Type contract for tool call guard. |
ToolCallOutcome | type | ToolCallOutcome | Type contract for tool call outcome. |
@fabric-harness/agent-registry
@fabric-harness/agent-registry
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
ActionRoute | type | ActionRoute | Type contract for action route. |
actionRouteSchema | value | z.ZodDiscriminatedUnion<[z.ZodObject<{ status: z.ZodLiteral<"auto-executed">; actionInvocationId: z.ZodString; }, z.core.$strip>, z.ZodObject<{ status: z.ZodLiteral<"awaiting-approval">; approvalRequestId: z.ZodString; reason: z.ZodString... | Runtime API for action route schema; the generated signature shows its accepted inputs and return type. |
AGENT_AUTONOMY_RANK | value | Record<"shadow" | "draft-only" | "approval-required" | "bounded", number> | Ranks used by subset/ceiling checks. Approval may only lower the rank. |
AgentAutonomy | type | "shadow" | "draft-only" | "approval-required" | "bounded" | Type contract for agent autonomy. |
agentAutonomySchema | value | z.ZodEnum<{ shadow: "shadow"; "draft-only": "draft-only"; "approval-required": "approval-required"; bounded: "bounded"; }> | Autonomy ceiling for a registered agent (ADR §2.3). |
AgentCapabilityGrantBase | type | { grantId: string; readTools: string[]; proposalActions: string[]; executionActions: string[]; skillIds?: string[]; expiresAt?: string; } | Type contract for agent capability grant base. |
agentCapabilityGrantBaseSchema | value | z.ZodObject<{ grantId: z.ZodString; readTools: z.ZodArray<z.ZodString>; proposalActions: z.ZodArray<z.ZodString>; executionActions: z.ZodDefault<z.ZodArray<z.ZodString>>; skillIds: z.ZodOptional<z.ZodArray<z.ZodString>>; expiresAt: z... | Capability grant with the three-way authority separation — read, propose, execute — preserved as a core guarantee (an agent that may propose cannot silently acquire delivery authority). Scope-free base; verticals extend. |
AgentDefinition | type | { agentDefinitionId: string; name: string; displayName: string; description: string; inputKinds: string[]; outputKinds: string[]; createdAt: string; } | Type contract for agent definition. |
agentDefinitionSchema | value | z.ZodObject<{ agentDefinitionId: z.ZodString; name: z.ZodString; displayName: z.ZodString; description: z.ZodString; inputKinds: z.ZodArray<z.ZodString>; outputKinds: z.ZodArray<z.ZodString>; createdAt: z.ZodString; }, z.core.$strip> | Runtime API for agent definition schema; the generated signature shows its accepted inputs and return type. |
AgentEventEnvelope | type | AgentEventEnvelope<T> | Type contract for agent event envelope. |
agentEventEnvelopeSchema | value | z.ZodObject<{ eventId: z.ZodString; type: z.ZodString; tenantId: z.ZodString; spaceId: z.ZodOptional<z.ZodString>; occurredAt: z.ZodString; correlationId: z.ZodString; event: z.ZodUnknown; }, z.core.$strip> | The family signed event envelope (ADR §3.7): the single normalized wire form for platform→agent event delivery, converging the origin protocol package's vertical webhook envelopes and the channel-tail envelopes. Signature standard: X-Fabric-Signature: v1=hex(hmac-sha256(secret, "<unix-seconds>.<raw-body>")) with the timestamp in X-Fabric-Timestamp, verified constant-time within a bounded skew. WebCrypto only — runs on Node and edge. |
AgentExecutionPrincipal | type | { principalId: string; tenantId: string; registrationId: string; agentDefinitionId: string; agentVersionId: string; agentRunId: string; temporalWorkflowId: string; grantId: string; correlationId: string; idempotencyKey?: string; requestHash?: string; causationId?: string;... | Type contract for agent execution principal. |
agentExecutionPrincipalSchema | value | z.ZodObject<{ principalId: z.ZodString; tenantId: z.ZodString; registrationId: z.ZodString; agentDefinitionId: z.ZodString; agentVersionId: z.ZodString; agentRunId: z.ZodString; temporalWorkflowId: z.ZodString; grantId: z.ZodString; idempotencyKey: z.ZodOptional<z.Z... | Short-lived execution principal minted per agent run. Verbatim (ADR §3.1 P). |
AgentExecutionUsageRecord | type | { usedTokens: number; usedCostUsd: number; inputTokens?: number; outputTokens?: number; maxCallOutputTokens?: number; modelCalls?: number; } | Type contract for agent execution usage record. |
agentExecutionUsageSchema | value | z.ZodObject<{ usedTokens: z.ZodNumber; usedCostUsd: z.ZodNumber; inputTokens: z.ZodOptional<z.ZodNumber>; outputTokens: z.ZodOptional<z.ZodNumber>; maxCallOutputTokens: z.ZodOptional<z.ZodNumber>; modelCalls: z.ZodOptional<z.ZodNumber>; },... | Runtime API for agent execution usage schema; the generated signature shows its accepted inputs and return type. |
AgentRunBase | type | { agentRunId: string; tenantId: string; registrationId: string; agentDefinitionId: string; agentVersionId: string; temporalWorkflowId: string; trigger: "manual" | "schedule" | "event" | "workflow"; status: "cancelled" | "queued" | "running" | "waiting-for-approval"... | Type contract for agent run base. |
agentRunBaseSchema | value | z.ZodObject<{ agentRunId: z.ZodString; tenantId: z.ZodString; registrationId: z.ZodString; agentDefinitionId: z.ZodString; agentVersionId: z.ZodString; temporalWorkflowId: z.ZodString; idempotencyKey: z.ZodOptional<z.ZodString>; requestHash: z.ZodOptional<z.Zo... | Agent run base — trigger, lifecycle, budget accounting, skill binding. Scope-free and attestation-free; verticals extend with their subject scope and their attestation schema (ADR §3.1 P-base). |
agentRunReliabilityMetricSchema | value | z.ZodDiscriminatedUnion<[z.ZodObject<{ status: z.ZodLiteral<"suppressed">; cohort: z.ZodLiteral<"fewer-than-10">; }, z.core.$strict>, z.ZodObject<{ status: z.ZodLiteral<"available">; cohortSize: z.ZodNumber; succeeded: z.ZodNumber;... | Runtime API for agent run reliability metric schema; the generated signature shows its accepted inputs and return type. |
AgentRunStage | type | "cancelled" | "queued" | "failed" | "loading-inputs" | "generating" | "staging-output" | "applying-mutations" | "completed" | Type contract for agent run stage. |
agentRunStageSchema | value | z.ZodEnum<{ queued: "queued"; failed: "failed"; cancelled: "cancelled"; "loading-inputs": "loading-inputs"; generating: "generating"; "staging-output": "staging-output"; "applying-mutations": "applying-mutations"; completed: "completed"; }> | Runtime API for agent run stage schema; the generated signature shows its accepted inputs and return type. |
agentRunStatusSchema | value | z.ZodEnum<{ queued: "queued"; running: "running"; "waiting-for-approval": "waiting-for-approval"; succeeded: "succeeded"; failed: "failed"; cancelled: "cancelled"; }> | Runtime API for agent run status schema; the generated signature shows its accepted inputs and return type. |
agentStatusSchema | value | z.ZodEnum<{ disabled: "disabled"; enabled: "enabled"; suspended: "suspended"; }> | Runtime API for agent status schema; the generated signature shows its accepted inputs and return type. |
AgentVersion | type | { agentVersionId: string; agentDefinitionId: string; version: string; configurationHash: string; promptVersion: string; skillIds: string[]; toolIds: string[]; modelPolicy: { provider: string; model: string; maxInputTokens: number; maxOutputTokens: number; maxCostUsd:... | Type contract for agent version. |
agentVersionSchema | value | z.ZodObject<{ agentVersionId: z.ZodString; agentDefinitionId: z.ZodString; version: z.ZodString; configurationHash: z.ZodString; implementationDigest: z.ZodOptional<z.ZodString>; runtimeVersion: z.ZodOptional<z.ZodString>; promptVersion: z.ZodString; skillI... | Immutable, hash-pinned agent version with hard model budgets. Verbatim from the origin — modelPolicy is the bounded-agent contract the MCP budget meter enforces (collaboration plan D10). |
approvalIsSubset | value | <T extends EnrollmentRegistrationLike>(requested: T, approved: T, scopeAccessors?: ReadonlyArray<(registration: T) => readonly string[]>) => boolean | Approval may narrow an external runtime's requested authority, but can never change its identity or increase any capability, scope, autonomy, or lifetime. Vertical scope dimensions (per-vertical scope-id lists) participate via scopeAccessors — each accessor's approved list must be a subset of its requested list. Wire-behavior-identical to the origin when the vertical passes its scope accessors (ADR §3.2, equivalence-tested). |
ApprovalRequest | type | { approvalRequestId: string; tenantId: string; subject: { subjectType: string; subjectId: string; }; proposedActionId: string; proposedParametersHash: string; reason: string; escalation: boolean; requiredCapability: string; options: ("approve" | "reject" | "ap... | Input contract for approval. |
approvalRequestSchema | value | z.ZodObject<{ approvalRequestId: z.ZodString; tenantId: z.ZodString; spaceId: z.ZodOptional<z.ZodString>; subject: z.ZodObject<{ subjectType: z.ZodString; subjectId: z.ZodString; }, z.core.$strip>; proposedActionId: z.ZodString; proposedParameters... | Runtime API for approval request schema; the generated signature shows its accepted inputs and return type. |
approvalRequestStatusSchema | value | z.ZodEnum<{ pending: "pending"; granted: "granted"; denied: "denied"; expired: "expired"; }> | Runtime API for approval request status schema; the generated signature shows its accepted inputs and return type. |
AttestedIdentity | type | { namespace: string; externalId: string; signatureRef?: string; } | Type contract for attested identity. |
attestedIdentitySchema | value | z.ZodObject<{ namespace: z.ZodString; externalId: z.ZodString; signatureRef: z.ZodOptional<z.ZodString>; }, z.core.$strict> | Runtime API for attested identity schema; the generated signature shows its accepted inputs and return type. |
BindExternalIdentityParams | type | { commandId: string; bindingId: string; principalId: string; namespace: string; externalId: string; verification: "self-asserted" | "signature" | "sso"; occurredAt: string; } | Type contract for bind external identity params. |
bindExternalIdentitySchema | value | z.ZodObject<{ commandId: z.ZodString; bindingId: z.ZodString; principalId: z.ZodString; namespace: z.ZodString; externalId: z.ZodString; verification: z.ZodEnum<{ "self-asserted": "self-asserted"; signature: "signature"; sso: "sso"; }>; occurredAt: z.Zo... | Runtime API for bind external identity schema; the generated signature shows its accepted inputs and return type. |
CapabilityDescriptor | type | CapabilityDescriptor | Action-catalog entry: what exists (grants say what a principal may use). |
CertificationSchemaOptions | type | CertificationSchemaOptions<TSchemaVersion, TEvidence, TDefinitionId> | Configuration options for certification schema. |
clampRoute | value | (autonomy: AgentAutonomy, decision: PolicyDecision) => ActionRoute | Clamp a per-action policy decision to the registration's autonomy ceiling. The registration autonomy is the ceiling; policy routes within it: - shadow → every mutation is rejected (observe/record only) - draft-only → at most awaiting-approval; nothing auto-executes - approval-required → at most awaiting-approval / escalated - bounded → policy result stands (auto-execution within grant + budget) The returned route for gated decisions carries an empty approvalRequestId — the caller creates the ApprovalRequest and fills it in. |
CompleteExternalAgentActivationParams | type | { commandId: string; enrollmentRequestId: string; expectedRequestHash: string; expectedApprovedEnvelopeHash: string; expectedFenceVersion: number; operatorDispatchId: string; activationActionInvocationId: string; } | Type contract for complete external agent activation params. |
completeExternalAgentActivationSchema | value | z.ZodObject<{ commandId: z.ZodString; enrollmentRequestId: z.ZodString; expectedRequestHash: z.ZodString; expectedApprovedEnvelopeHash: z.ZodString; expectedFenceVersion: z.ZodNumber; operatorDispatchId: z.ZodString; activationActionInvocationId: z.ZodString; }, z... | Runtime API for complete external agent activation schema; the generated signature shows its accepted inputs and return type. |
CompleteExternalAgentOffboardingParams | type | { commandId: string; enrollmentRequestId: string; expectedRequestHash: string; expectedFenceVersion: number; operatorDispatchId: string; terminalDisposition: "revoked" | "expired"; registrationActionInvocationId?: string; credentialActionInvocationId?: string; } | Type contract for complete external agent offboarding params. |
completeExternalAgentOffboardingSchema | value | z.ZodObject<{ commandId: z.ZodString; enrollmentRequestId: z.ZodString; expectedRequestHash: z.ZodString; expectedFenceVersion: z.ZodNumber; operatorDispatchId: z.ZodString; registrationActionInvocationId: z.ZodOptional<z.ZodString>; credentialActionInvocationId:... | Runtime API for complete external agent offboarding schema; the generated signature shows its accepted inputs and return type. |
CompleteExternalAgentProvisioningParams | type | { commandId: string; enrollmentRequestId: string; expectedRequestHash: string; expectedApprovedEnvelopeHash: string; expectedFenceVersion: number; operatorDispatchId: string; registrationActionInvocationId: string; credentialActionInvocationId: string; credentialId: strin... | Type contract for complete external agent provisioning params. |
completeExternalAgentProvisioningSchema | value | z.ZodObject<{ commandId: z.ZodString; enrollmentRequestId: z.ZodString; expectedRequestHash: z.ZodString; expectedApprovedEnvelopeHash: z.ZodString; expectedFenceVersion: z.ZodNumber; operatorDispatchId: z.ZodString; registrationActionInvocationId: z.ZodString; credent... | Runtime API for complete external agent provisioning schema; the generated signature shows its accepted inputs and return type. |
ContentRef | type | { id: string; revision: number; contentHash: string; } | Type contract for content ref. |
contentRefSchema | value | z.ZodObject<{ id: z.ZodString; revision: z.ZodNumber; contentHash: z.ZodString; }, z.core.$strip> | Content-addressed reference to a revisioned artifact-like subject. |
CorrelationKey | type | { type: string; value: string; } | Type contract for correlation key. |
correlationKeySchema | value | z.ZodObject<{ type: z.ZodString; value: z.ZodString; }, z.core.$strip> | Runtime API for correlation key schema; the generated signature shows its accepted inputs and return type. |
createCertificationSchema | value | <TSchemaVersion extends string, TEvidence extends z.ZodTypeAny, TDefinitionId extends z.ZodTypeAny = z.ZodString>(options: CertificationSchemaOptions<TSchemaVersion, TEvidence, TDefinitionId>) => z.ZodObject<{ schemaVersion: z.ZodLiteral<TSchemaVersio... | Factory for the immutable certification record (ADR §3.1 P-fact). |
createEnrollmentContracts | value | <TRegistration extends z.ZodTypeAny>(options: EnrollmentContractsOptions<TRegistration>) => { submitExternalAgentEnrollmentSchema: z.ZodObject<{ commandId: z.ZodString; enrollmentRequestId: z.ZodString; inviteId: z.ZodString; runtimeKind: z.ZodEnum&... | Factory for the registration-dependent enrollment contracts. The vertical supplies its registration schema; everything else is neutral (ADR §3.2). |
CreateExternalAgentInviteParams | type | { commandId: string; inviteId: string; inviteRevealId: string; runtimeKind: "hermes" | "generic-mcp"; expiresAt: string; } | Type contract for create external agent invite params. |
createExternalAgentInviteSchema | value | z.ZodObject<{ commandId: z.ZodString; inviteId: z.ZodString; inviteRevealId: z.ZodString; runtimeKind: z.ZodEnum<{ hermes: "hermes"; "generic-mcp": "generic-mcp"; }>; expiresAt: z.ZodString; }, z.core.$strict> | Creates external agent invite schema. |
createOutcomeEvidenceSchema | value | <TSchemaVersion extends string, TVersionExtension extends z.ZodRawShape = Record<never, never>, TDefinitionId extends z.ZodTypeAny = z.ZodString>(options: OutcomeEvidenceSchemaOptions<TSchemaVersion, TVersionExtension, TDefinitionId>) => z.ZodObject<... | Creates outcome evidence schema. |
createSignalOutboxReconciler | value | (deps: SignalOutboxReconcilerDeps) => () => Promise<{ delivered: number; failed: number; }> | Idempotent outbox reconciler (plan D16). Run from a worker loop, a Temporal activity, or after the vertical action commits. Safe under concurrent workers and restarts: the checkpoint is a CAS in the store, and receiving workflows dedupe on approvalRequestId. |
createSkillIoSchema | value | <TSchemaVersion extends string>(schemaVersion: TSchemaVersion) => z.ZodObject<{ schemaVersion: z.ZodLiteral<TSchemaVersion>; fields: z.ZodArray<z.ZodObject<{ name: z.ZodString; type: z.ZodEnum<{ string: "string"; number: "number"; bool... | IO contract factory — the vertical supplies its schemaVersion literal. |
createSkillRunnerExecutionInputSchema | value | <TIo extends z.ZodTypeAny>(ioSchema: TIo) => z.ZodObject<{ skillId: z.ZodString; skillVersion: z.ZodNumber; name: z.ZodString; description: z.ZodString; instructions: z.ZodString; inputSchema: TIo; outputSchema: TIo; allowedActions: z.ZodArray<z.ZodString&g... | Execution-input factory. runtimePolicy promotes verbatim — bounded iterations/timeout/tokens/cost/concurrency with failureMode: fail_closed is a core finite-agent guarantee, not a vertical choice. |
DecisionEvent | type | { approvalRequestId: string; tenantId: string; subject: { subjectType: string; subjectId: string; }; occurredAt: string; type: "decision.requested"; escalation: boolean; } | { approvalRequestId: string; tenantId: string; subject: { subjectType: s... | Type contract for decision event. |
decisionEventSchema | value | z.ZodDiscriminatedUnion<[z.ZodObject<{ approvalRequestId: z.ZodString; tenantId: z.ZodString; subject: z.ZodObject<{ subjectType: z.ZodString; subjectId: z.ZodString; }, z.core.$strip>; occurredAt: z.ZodString; type: z.ZodLiteral<"decision.request... | Runtime API for decision event schema; the generated signature shows its accepted inputs and return type. |
decisionOptionSchema | value | z.ZodEnum<{ approve: "approve"; reject: "reject"; "approve-with-edits": "approve-with-edits"; }> | Runtime API for decision option schema; the generated signature shows its accepted inputs and return type. |
DecisionRefusal | type | DecisionRefusal | Type contract for decision refusal. |
DecisionSubject | type | { subjectType: string; subjectId: string; } | Type contract for decision subject. |
decisionSubjectSchema | value | z.ZodObject<{ subjectType: z.ZodString; subjectId: z.ZodString; }, z.core.$strip> | Runtime API for decision subject schema; the generated signature shows its accepted inputs and return type. |
EnforceExternalAgentEnrollmentRetentionParams | type | { commandId: string; cutoffAt: string; limit: number; } | Type contract for enforce external agent enrollment retention params. |
enforceExternalAgentEnrollmentRetentionSchema | value | z.ZodObject<{ commandId: z.ZodString; cutoffAt: z.ZodString; limit: z.ZodNumber; }, z.core.$strict> | Runtime API for enforce external agent enrollment retention schema; the generated signature shows its accepted inputs and return type. |
EnrollmentContractsOptions | type | EnrollmentContractsOptions<TRegistration> | Configuration options for enrollment contracts. |
EnrollmentRegistrationLike | type | EnrollmentRegistrationLike | Minimal registration shape the subset check operates over. |
externalActionContractFingerprintSchema | value | z.ZodString | Pins the exact action contract an external runtime was approved against. |
ExternalAgentEnrollmentInviteRecord | type | { inviteId: string; runtimeKind: "hermes" | "generic-mcp"; tokenHash: string; status: "revoked" | "active" | "consumed"; createdBy: string; createdAt: string; expiresAt: string; retentionUntil: string; consumedByRequestId?: string; revokedAt?: string; revocationReason?... | Type contract for external agent enrollment invite record. |
externalAgentEnrollmentInviteRecordSchema | value | z.ZodObject<{ inviteId: z.ZodString; runtimeKind: z.ZodEnum<{ hermes: "hermes"; "generic-mcp": "generic-mcp"; }>; tokenHash: z.ZodString; status: z.ZodEnum<{ revoked: "revoked"; active: "active"; consumed: "consumed"; }>; createdBy: z.Zo... | Runtime API for external agent enrollment invite record schema; the generated signature shows its accepted inputs and return type. |
ExternalAgentEnrollmentInviteStatus | type | "revoked" | "active" | "consumed" | Type contract for external agent enrollment invite status. |
externalAgentEnrollmentInviteStatusSchema | value | z.ZodEnum<{ revoked: "revoked"; active: "active"; consumed: "consumed"; }> | Runtime API for external agent enrollment invite status schema; the generated signature shows its accepted inputs and return type. |
ExternalAgentEnrollmentStatus | type | "revoked" | "approved" | "rejected" | "active" | "expired" | "pending_review" | "provisioning" | "claim_ready" | "claimed_pending_activation" | "revoking" | Type contract for external agent enrollment status. |
externalAgentEnrollmentStatusSchema | value | z.ZodEnum<{ revoked: "revoked"; rejected: "rejected"; expired: "expired"; approved: "approved"; active: "active"; pending_review: "pending_review"; provisioning: "provisioning"; claim_ready: "claim_ready"; claimed_pending_activation: "claimed_pending_activation"; revok... | Runtime API for external agent enrollment status schema; the generated signature shows its accepted inputs and return type. |
ExternalAgentInviteRevealRecord | type | { inviteRevealId: string; inviteId: string; ciphertext: string; payloadHash: string; encryptionKeyId: string; associatedDataHash: string; createdAt: string; expiresAt: string; revealedAt?: string; revealedByCommandId?: string; replayUntil?: string; } | Type contract for external agent invite reveal record. |
externalAgentInviteRevealRecordSchema | value | z.ZodObject<{ inviteRevealId: z.ZodString; inviteId: z.ZodString; ciphertext: z.ZodString; payloadHash: z.ZodString; encryptionKeyId: z.ZodString; associatedDataHash: z.ZodString; createdAt: z.ZodString; expiresAt: z.ZodString; revealedAt: z.ZodOptional<z.ZodString&... | Runtime API for external agent invite reveal record schema; the generated signature shows its accepted inputs and return type. |
ExternalAgentMutationFence | type | { enrollmentRequestId: string; requestHash: string; fenceVersion: number; allowedStatuses: ("revoked" | "approved" | "rejected" | "active" | "expired" | "pending_review" | "provisioning" | "claim_ready" | "claimed_pending_activation" | "revoking")[]; approvedEnve... | Type contract for external agent mutation fence. |
externalAgentMutationFenceSchema | value | z.ZodObject<{ enrollmentRequestId: z.ZodString; requestHash: z.ZodString; approvedEnvelopeHash: z.ZodOptional<z.ZodString>; fenceVersion: z.ZodNumber; allowedStatuses: z.ZodArray<z.ZodEnum<{ revoked: "revoked"; rejected: "rejected"; expired: "expired";... | Runtime API for external agent mutation fence schema; the generated signature shows its accepted inputs and return type. |
ExternalAgentOperatorAdmissionRecord | type | { admissionId: string; dispatchId: string; enrollmentRequestId: string; workflowId: string; workflowRunId: string; actionId: string; stagedCommandId: string; parameterHash: string; fenceVersion: number; issuedAt: string; expiresAt: string; consumedByActionInvocationId?: s... | Type contract for external agent operator admission record. |
externalAgentOperatorAdmissionRecordSchema | value | z.ZodObject<{ admissionId: z.ZodString; dispatchId: z.ZodString; enrollmentRequestId: z.ZodString; workflowId: z.ZodString; workflowRunId: z.ZodString; actionId: z.ZodString; stagedCommandId: z.ZodString; parameterHash: z.ZodString; fenceVersion: z.ZodNumber; issuedAt:... | Runtime API for external agent operator admission record schema; the generated signature shows its accepted inputs and return type. |
ExternalAgentOperatorDispatchRecord | type | { dispatchId: string; enrollmentRequestId: string; kind: "provisioning" | "activation" | "offboarding"; bindingHash: string; sourceActionInvocationId: string; fenceVersion: number; status: "completed" | "pending" | "started"; workflowId: string; createdAt: string; app... | Type contract for external agent operator dispatch record. |
externalAgentOperatorDispatchRecordSchema | value | z.ZodObject<{ dispatchId: z.ZodString; enrollmentRequestId: z.ZodString; kind: z.ZodEnum<{ provisioning: "provisioning"; activation: "activation"; offboarding: "offboarding"; }>; bindingHash: z.ZodString; sourceActionInvocationId: z.ZodString; approvedE... | Runtime API for external agent operator dispatch record schema; the generated signature shows its accepted inputs and return type. |
externalAgentOperatorDispatchStatusSchema | value | z.ZodEnum<{ completed: "completed"; pending: "pending"; started: "started"; }> | Runtime API for external agent operator dispatch status schema; the generated signature shows its accepted inputs and return type. |
externalAgentOperatorKindSchema | value | z.ZodEnum<{ provisioning: "provisioning"; activation: "activation"; offboarding: "offboarding"; }> | Runtime API for external agent operator kind schema; the generated signature shows its accepted inputs and return type. |
ExternalAgentRevealEnvelopeRecord | type | { revealEnvelopeId: string; enrollmentRequestId: string; registrationId: string; credentialId: string; credentialVersion: string; ciphertext: string; payloadHash: string; purpose: "registration-credential"; encryptionKeyId: string; associatedDataHash: string; createdAt: s... | Type contract for external agent reveal envelope record. |
externalAgentRevealEnvelopeRecordSchema | value | z.ZodObject<{ revealEnvelopeId: z.ZodString; enrollmentRequestId: z.ZodString; registrationId: z.ZodString; credentialId: z.ZodString; credentialVersion: z.ZodString; ciphertext: z.ZodString; payloadHash: z.ZodString; purpose: z.ZodLiteral<"registration-credential"&... | Runtime API for external agent reveal envelope record schema; the generated signature shows its accepted inputs and return type. |
ExternalAgentRuntimeKind | type | "hermes" | "generic-mcp" | Type contract for external agent runtime kind. |
externalAgentRuntimeKindSchema | value | z.ZodEnum<{ hermes: "hermes"; "generic-mcp": "generic-mcp"; }> | generic-mcp is the runtime kind for channel-hosted ACP + MCP agents. |
FABRIC_SIGNATURE_HEADER | value | "x-fabric-signature" | Constant defining fabric signature header. |
FABRIC_TIMESTAMP_HEADER | value | "x-fabric-timestamp" | Constant defining fabric timestamp header. |
FieldValue | type | FieldValue<T, TSource> | Field value with confidence and provenance — used when an agent submits extracted data so per-action policy can route it (auto-execute, approval, or escalate) based on confidence. Promoted from the origin protocol package (ADR §3.6) with one erratum: the origin's source union carries vertical vocabulary, so the neutral form takes an open provenance string and the vertical narrows it in its own re-export (TSource defaults to string). |
GovernanceNotice | type | { noticeId: string; tenantId: string; kind: "escalation" | "binding-refused" | "capability-refused" | "validation-failed" | "policy-blocked" | "budget-exhausted"; reason: string; occurredAt: string; subject?: { subjectType: string; subjectId: string; }; act... | Type contract for governance notice. |
governanceNoticeSchema | value | z.ZodObject<{ noticeId: z.ZodString; tenantId: z.ZodString; subject: z.ZodOptional<z.ZodObject<{ subjectType: z.ZodString; subjectId: z.ZodString; }, z.core.$strip>>; kind: z.ZodEnum<{ escalation: "escalation"; "binding-refused": "binding-... | Runtime API for governance notice schema; the generated signature shows its accepted inputs and return type. |
GovernedProposalPort | type | GovernedProposalPort | The only write path an agent has: propose a governed Platform action. |
IdentityBinding | type | { bindingId: string; tenantId: string; principalId: string; namespace: string; externalId: string; verification: "self-asserted" | "signature" | "sso"; boundAt: string; boundBy: string; revokedAt?: string; revokedBy?: string; revocationReason?: string; } | Type contract for identity binding. |
identityBindingSchema | value | z.ZodObject<{ bindingId: z.ZodString; tenantId: z.ZodString; principalId: z.ZodString; namespace: z.ZodString; externalId: z.ZodString; verification: z.ZodEnum<{ "self-asserted": "self-asserted"; signature: "signature"; sso: "sso"; }>; boundAt: z.ZodStr... | Runtime API for identity binding schema; the generated signature shows its accepted inputs and return type. |
identityNamespaceSchema | value | z.ZodString | Identity bindings (ADR §3.8): the typed, revocable link between an external surface identity (a Nostr pubkey, Slack member id, email, …) and a Fabric principal. Supersedes untyped actor-id lists for new decisions; binding and revoking are governed actions in each vertical's module, so "who may decide as whom" is itself audited history. |
IdentityVerification | type | "self-asserted" | "signature" | "sso" | Type contract for identity verification. |
identityVerificationSchema | value | z.ZodEnum<{ "self-asserted": "self-asserted"; signature: "signature"; sso: "sso"; }> | Runtime API for identity verification schema; the generated signature shows its accepted inputs and return type. |
idSchema | value | z.ZodString | Shared field primitives. Exactly the shapes used by the origin vertical packages so extracted schemas stay wire-identical — see the Fabric Agent Contracts Reconciliation ADR §1. |
inMemorySignalOutboxStore | value | () => SignalOutboxStore & { all(): SignalOutboxIntent[]; add(intent: SignalOutboxIntent): void; } | Test/development outbox store. Not durable — never use in production. |
isoDateSchema | value | z.ZodString | Runtime API for iso date schema; the generated signature shows its accepted inputs and return type. |
JsonObject | type | Record<string, unknown> | Type contract for json object. |
jsonObjectSchema | value | z.ZodRecord<z.ZodString, z.ZodUnknown> | Runtime API for json object schema; the generated signature shows its accepted inputs and return type. |
MutationCommonInput | type | MutationCommonInput | Common metadata every agent-proposed mutation carries (ADR §3.5). |
NamespacedKind | type | string | Type contract for namespaced kind. |
namespacedKindSchema | value | z.ZodString | Namespaced kind identifier: lowercase, dot/dash namespacing, no vertical vocabulary. Wire-identical to the origin artifactKindSchema regex so vertical re-exports validate exactly as before (ADR §3.3). |
OutcomeEvidenceSchemaOptions | type | OutcomeEvidenceSchemaOptions<TSchemaVersion, TVersionExtension, TDefinitionId> | Configuration options for outcome evidence schema. |
PolicyDecision | type | PolicyDecision | Type contract for policy decision. |
PolicyEvaluationInput | type | PolicyEvaluationInput | Type contract for policy evaluation input. |
PolicyHint | type | PolicyHint | Type contract for policy hint. |
RecordExternalAgentClaimParams | type | { commandId: string; enrollmentRequestId: string; expectedRequestHash: string; expectedApprovedEnvelopeHash: string; expectedFenceVersion: number; operatorDispatchId: string; credentialId: string; credentialVersion: string; revealEnvelopeId: string; } | Type contract for record external agent claim params. |
recordExternalAgentClaimSchema | value | z.ZodObject<{ commandId: z.ZodString; enrollmentRequestId: z.ZodString; expectedRequestHash: z.ZodString; expectedApprovedEnvelopeHash: z.ZodString; expectedFenceVersion: z.ZodNumber; operatorDispatchId: z.ZodString; credentialId: z.ZodString; credentialVersion: z.ZodS... | Runtime API for record external agent claim schema; the generated signature shows its accepted inputs and return type. |
resolveAgentRunTokenBudget | value | (policy: AgentVersion["modelPolicy"]) => number | Resolves agent run token budget. |
ResolvedDecisionContext | type | ResolvedDecisionContext | Type contract for resolved decision context. |
RevokeExternalAgentEnrollmentParams | type | { commandId: string; enrollmentRequestId: string; expectedRequestHash: string; reason: string; } | Type contract for revoke external agent enrollment params. |
revokeExternalAgentEnrollmentSchema | value | z.ZodObject<{ commandId: z.ZodString; enrollmentRequestId: z.ZodString; expectedRequestHash: z.ZodString; reason: z.ZodString; }, z.core.$strict> | Runtime API for revoke external agent enrollment schema; the generated signature shows its accepted inputs and return type. |
RevokeExternalAgentInviteParams | type | { commandId: string; inviteId: string; reason: string; } | Type contract for revoke external agent invite params. |
revokeExternalAgentInviteSchema | value | z.ZodObject<{ commandId: z.ZodString; inviteId: z.ZodString; reason: z.ZodString; }, z.core.$strict> | Runtime API for revoke external agent invite schema; the generated signature shows its accepted inputs and return type. |
RevokeExternalIdentityParams | type | { commandId: string; bindingId: string; reason: string; occurredAt: string; } | Type contract for revoke external identity params. |
revokeExternalIdentitySchema | value | z.ZodObject<{ commandId: z.ZodString; bindingId: z.ZodString; reason: z.ZodString; occurredAt: z.ZodString; }, z.core.$strict> | Runtime API for revoke external identity schema; the generated signature shows its accepted inputs and return type. |
RiskTier | type | "low" | "medium" | "high" | Type contract for risk tier. |
riskTierSchema | value | z.ZodEnum<{ low: "low"; medium: "medium"; high: "high"; }> | The neutral decision boundary (ADR §2, §3.5, §3.7, §3.8): routing vocabulary, per-action policy contracts, the ApprovalRequest entity, the durable-resume primitive, and the governed decision-ingress factory. Layering (collaboration plan D7): channel adapters carry candidate identities and never authorize; only a vertical's governed decision-ingress action — composed from createDecisionIngress — resolves bindings, checks capability, and signals durable workflows. |
sha256Schema | value | z.ZodString | Runtime API for sha256 schema; the generated signature shows its accepted inputs and return type. |
SignalOutboxIntent | type | { intentId: string; tenantId: string; approvalRequestId: string; correlationKey: { type: string; value: string; }; signalName: string; payload: Record<string, unknown>; idempotencyKey: string; createdAt: string; attempts: number; deliveredAt?: string; last... | Type contract for signal outbox intent. |
signalOutboxIntentSchema | value | z.ZodObject<{ intentId: z.ZodString; tenantId: z.ZodString; approvalRequestId: z.ZodString; correlationKey: z.ZodObject<{ type: z.ZodString; value: z.ZodString; }, z.core.$strip>; signalName: z.ZodString; payload: z.ZodRecord<z.ZodString, z.ZodUnknow... | Durable signal-outbox intent, persisted atomically with the decision. |
SignalOutboxReconcilerDeps | type | SignalOutboxReconcilerDeps | Type contract for signal outbox reconciler deps. |
SignalOutboxStore | type | SignalOutboxStore | Storage contract for signal outbox. |
SignalPendingStepInput | type | SignalPendingStepInput | Type contract for signal pending step input. |
SignalPendingStepResult | type | SignalPendingStepResult | Result returned by signal pending step. |
signFabricEnvelope | value | (secret: string, timestampSeconds: number, rawBody: string) => Promise<string> | Sign a raw body for delivery: returns the v1=<hex> header value. |
SkillActionProposal | type | { actionId: string; parameters: Record<string, unknown>; reason: string; } | Type contract for skill action proposal. |
skillActionProposalSchema | value | z.ZodObject<{ actionId: z.ZodString; parameters: z.ZodRecord<z.ZodString, z.ZodUnknown>; reason: z.ZodString; }, z.core.$strict> | Skill-runner contracts (ADR §3.1 P-fact): bounded, fail-closed skill execution with action proposals. IO-contract literals are vertical-supplied. |
SkillRunnerOutput | type | { output: Record<string, unknown>; proposedActions: { actionId: string; parameters: Record<string, unknown>; reason: string; }[]; } | Type contract for skill runner output. |
skillRunnerOutputSchema | value | z.ZodObject<{ output: z.ZodRecord<z.ZodString, z.ZodUnknown>; proposedActions: z.ZodDefault<z.ZodArray<z.ZodObject<{ actionId: z.ZodString; parameters: z.ZodRecord<z.ZodString, z.ZodUnknown>; reason: z.ZodString; }, z.core.$strict>>... | Runtime API for skill runner output schema; the generated signature shows its accepted inputs and return type. |
SubjectContextPort | type | SubjectContextPort | Neutral read port keyed by subject reference (ADR §3.4). |
SubmitExternalDecisionInput | type | { commandId: string; approvalRequestId: string; choice: "approve" | "reject" | "approve-with-edits"; attestedIdentity: { namespace: string; externalId: string; signatureRef?: string; }; occurredAt: string; edits?: Record<string, unknown>; receipt?: {... | Type contract for submit external decision input. |
submitExternalDecisionSchema | value | z.ZodObject<{ commandId: z.ZodString; approvalRequestId: z.ZodString; choice: z.ZodEnum<{ approve: "approve"; reject: "reject"; "approve-with-edits": "approve-with-edits"; }>; edits: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>; att... | Runtime API for submit external decision schema; the generated signature shows its accepted inputs and return type. |
suppressedOutcomeMetricSchema | value | z.ZodObject<{ status: z.ZodLiteral<"suppressed">; cohort: z.ZodLiteral<"fewer-than-10">; }, z.core.$strict> | Privacy-safe longitudinal outcome evidence (ADR §3.1 P-fact): cohorts below ten observations expose no exact counts; no tenant, subject, actor, prompt, body, or failure-detail fields. The base carries run reliability; verticals extend per-version entries with their own metric families and pass their schemaVersion literal. |
TenantAgentRegistrationBase | type | { registrationId: string; tenantId: string; agentDefinitionId: string; agentVersionId: string; status: "disabled" | "enabled" | "suspended"; autonomy: "shadow" | "draft-only" | "approval-required" | "bounded"; grant: { grantId: string; readTools: string[]; propo... | Type contract for tenant agent registration base. |
tenantAgentRegistrationBaseSchema | value | z.ZodObject<{ registrationId: z.ZodString; tenantId: z.ZodString; agentDefinitionId: z.ZodString; agentVersionId: z.ZodString; status: z.ZodEnum<{ disabled: "disabled"; enabled: "enabled"; suspended: "suspended"; }>; autonomy: z.ZodEnum<{ shadow... | Tenant-level registration base (scope-free; verticals extend). |
ValidatedDecision | type | ValidatedDecision | Type contract for validated decision. |
validateExternalDecision | value | (input: SubmitExternalDecisionInput, context: ResolvedDecisionContext) => ValidatedDecision | PURE decision validation (plan D16). No I/O, no clock reads, no effects — every input is resolved by the caller first. Returns either a refusal (with the governance notice the caller must emit and audit), expiry, or the exact decision record + signal-outbox intent the caller must persist atomically with its pending→terminal compare-and-set. |
verifyFabricEnvelope | value | (secret: string, rawBody: string, headers: { signature: string | null; timestamp: string | null; }, options?: { maxSkewSeconds?: number; nowMs?: number; }) => Promise<boolean> | Constant-time verification of a v1= signature within maxSkewSeconds. |
@fabric-harness/azure
@fabric-harness/azure
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
AzureAksClusterRef | type | AzureAksClusterRef | Type contract for azure aks cluster ref. |
azureAksRunCommandTool | value | (client: AzureArmClient, options?: { name?: string; description?: string; apiVersion?: string; }) => ToolDef<AzureAksClusterRef & { command: string; context?: string; }, unknown> | Model-callable tool or tool factory for azure aks run command. |
AzureArmClient | value | typeof AzureArmClient | Client implementation for azure arm. |
AzureArmClientOptions | type | AzureArmClientOptions | Configuration options for azure arm client. |
AzureBlobArtifactStore | type | AzureBlobArtifactStore | Storage contract for azure blob artifact. |
AzureBlobArtifactStoreOptions | type | AzureBlobArtifactStoreOptions | Configuration options for azure blob artifact store. |
AzureBundle | type | AzureBundle | Type contract for azure bundle. |
AzureBundleConfig | type | AzureBundleConfig | Type contract for azure bundle config. |
AzureContainerAppsJobRef | type | AzureContainerAppsJobRef | Type contract for azure container apps job ref. |
azureContainerAppsJobTool | value | (client: AzureArmClient, options?: { name?: string; description?: string; apiVersion?: string; }) => ToolDef<AzureContainerAppsJobRef & { environmentVariables?: Record<string, string>; }, unknown> | Model-callable tool or tool factory for azure container apps job. |
azureContainerInstanceExecTool | value | (client: AzureArmClient, options?: { name?: string; description?: string; apiVersion?: string; }) => ToolDef<AzureContainerInstanceRef & { command: string; }, unknown> | Model-callable tool or tool factory for azure container instance exec. |
AzureContainerInstanceRef | type | AzureContainerInstanceRef | Type contract for azure container instance ref. |
azureKeyVaultSecretProvider | value | (options: AzureKeyVaultSecretResolverOptions) => SecretProvider | Key Vault adapter for chainSecretProviders() and secretResolver(). |
AzureKeyVaultSecretResolverOptions | type | AzureKeyVaultSecretResolverOptions | Configuration options for azure key vault secret resolver. |
AzureOpenAIModelProvider | value | typeof AzureOpenAIModelProvider | Provider implementation for azure open aimodel. |
AzureOpenAIModelProviderOptions | type | AzureOpenAIModelProviderOptions | Configuration options for azure open aimodel provider. |
AzureResourceRef | type | AzureResourceRef | Type contract for azure resource ref. |
createAzureArmClient | value | (options: AzureArmClientOptions) => AzureArmClient | Creates azure arm client. |
createAzureBlobArtifactStore | value | (options: AzureBlobArtifactStoreOptions) => AzureBlobArtifactStore | Creates azure blob artifact store. |
createAzureKeyVaultSecretResolver | value | (options: AzureKeyVaultSecretResolverOptions) => (name: string) => Promise<string | undefined> | Creates azure key vault secret resolver. |
createFoundryAgentServiceClient | value | (options: FoundryAgentServiceOptions) => FoundryAgentServiceClient | Creates foundry agent service client. |
defineAzureAgent | value | <TInput = JsonObject, TOutput = unknown>(options?: DefineAzureAgentOptions<TInput, TOutput>) => DefinedAgent<TInput, TOutput> | Defines azure agent. |
DefineAzureAgentOptions | type | DefineAzureAgentOptions<TInput, TOutput> | Configuration options for define azure agent. |
FoundryAgentDefinition | type | FoundryAgentDefinition | Type contract for foundry agent definition. |
FoundryAgentInvocationOptions | type | FoundryAgentInvocationOptions | Configuration options for foundry agent invocation. |
FoundryAgentInvocationResult | type | FoundryAgentInvocationResult | Result returned by foundry agent invocation. |
foundryAgentLifecycleTools | value | (client: FoundryAgentServiceClient) => ToolDef[] | Runtime API for foundry agent lifecycle tools; the generated signature shows its accepted inputs and return type. |
FoundryAgentServiceClient | value | typeof FoundryAgentServiceClient | Client implementation for foundry agent service. |
FoundryAgentServiceOptions | type | FoundryAgentServiceOptions | Configuration options for foundry agent service. |
foundryAgentTool | value | (client: FoundryAgentServiceClient, options?: { name?: string; description?: string; agentId?: string; }) => ToolDef<{ prompt: string; threadId?: string; }, FoundryAgentInvocationResult> | Model-callable tool or tool factory for foundry agent. |
FoundryHostedAgentSandboxOptions | type | FoundryHostedAgentSandboxOptions | Configuration options for foundry hosted agent sandbox. |
FoundryRuntimeModelProvider | value | typeof FoundryRuntimeModelProvider | Model provider that calls the Foundry-managed Azure OpenAI surface using a Bearer token (managed identity) instead of an API key. Designed for the Azure AI Foundry Hosted Agent runtime, but useful on any Azure compute with a managed identity (ACA / AKS / VM) — you don't need the Foundry runtime adapter to use this provider. The runtime injects: - AZURE_OPENAI_ENDPOINT — the Foundry-routed Azure OpenAI endpoint. - AZURE_OPENAI_DEPLOYMENT — the model deployment name. - FOUNDRY_AGENT_TOKEN (or AZURE_AI_FOUNDRY_TOKEN) — a pre-issued token when running inside the Hosted Agent contain... |
FoundryRuntimeModelProviderOptions | type | FoundryRuntimeModelProviderOptions | Configuration options for foundry runtime model provider. |
FoundryThreadMessage | type | FoundryThreadMessage | Type contract for foundry thread message. |
FoundryTokenResolver | type | FoundryTokenResolver | Token resolver — returns a Bearer token for the Foundry runtime's managed Azure OpenAI surface. Implementations may cache and refresh. |
MockAzureModelProvider | value | typeof MockAzureModelProvider | A deterministic ModelProvider for Azure agent tests and init templates. Returns structured responses without requiring real Azure credentials. |
MockAzureModelProviderOptions | type | MockAzureModelProviderOptions | Configuration options for mock azure model provider. |
resolveToolRefs | value | (bundle: AzureBundle, refs: string[]) => ToolDef[] | Resolves tool refs. |
@fabric-harness/azure/aks-sandbox
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
aksSandbox | value | (options: AksSandboxOptions) => Promise<SandboxEnv> | Sandbox adapter for aks. |
AksSandboxOptions | type | AksSandboxOptions | AKS-flavored Kubernetes sandbox. Pulls cluster credentials from the AKS listClusterUserCredentials endpoint, builds a @kubernetes/client-node KubeConfig, and delegates to kubernetesSandbox. Requires both peer deps: ```sh npm install |
@fabric-harness/azure/app-insights
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
ApplicationInsightsClientLike | type | ApplicationInsightsClientLike | Optional Azure Monitor / Application Insights telemetry exporter. Adapts Fabric's TelemetrySpan shape into App Insights TelemetryClient trackDependency calls. The Azure Monitor SDK is provided by the caller — we don't take a hard dependency. Install peer dep: See the package declarations for an example. Usage: See the package declarations for an example. |
applicationInsightsExporter | value | (options: ApplicationInsightsExporterOptions) => TelemetryExporter | Runtime API for application insights exporter; the generated signature shows its accepted inputs and return type. |
ApplicationInsightsExporterOptions | type | ApplicationInsightsExporterOptions | Configuration options for application insights exporter. |
@fabric-harness/azure/foundry-runtime
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
FoundryRuntimeModelProvider | value | typeof FoundryRuntimeModelProvider | Model provider that calls the Foundry-managed Azure OpenAI surface using a Bearer token (managed identity) instead of an API key. Designed for the Azure AI Foundry Hosted Agent runtime, but useful on any Azure compute with a managed identity (ACA / AKS / VM) — you don't need the Foundry runtime adapter to use this provider. The runtime injects: - AZURE_OPENAI_ENDPOINT — the Foundry-routed Azure OpenAI endpoint. - AZURE_OPENAI_DEPLOYMENT — the model deployment name. - FOUNDRY_AGENT_TOKEN (or AZURE_AI_FOUNDRY_TOKEN) — a pre-issued token when running inside the Hosted Agent contain... |
FoundryRuntimeModelProviderOptions | type | FoundryRuntimeModelProviderOptions | Configuration options for foundry runtime model provider. |
FoundryTokenResolver | type | FoundryTokenResolver | Token resolver — returns a Bearer token for the Foundry runtime's managed Azure OpenAI surface. Implementations may cache and refresh. |
@fabric-harness/azure/agent
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
azure | value | (config: AzureBundleConfig) => AzureBundle | Bundle factory for Azure agents. Returns an AzureBundle with a model provider, Azure-specific tools, and a safe default egress policy. |
AzureBundle | type | AzureBundle | Type contract for azure bundle. |
AzureBundleConfig | type | AzureBundleConfig | Type contract for azure bundle config. |
defineAzureAgent | value | <TInput = JsonObject, TOutput = unknown>(options?: DefineAzureAgentOptions<TInput, TOutput>) => DefinedAgent<TInput, TOutput> | Defines azure agent. |
DefineAzureAgentOptions | type | DefineAzureAgentOptions<TInput, TOutput> | Configuration options for define azure agent. |
resolveToolRefs | value | (bundle: AzureBundle, refs: string[]) => ToolDef[] | Resolves tool refs. |
@fabric-harness/channels
@fabric-harness/channels
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
bytesToHex | value | (bytes: Uint8Array) => string | Runtime API for bytes to hex; the generated signature shows its accepted inputs and return type. |
Channel | type | Channel | Type contract for channel. |
channelCompatibility | value | { readonly slack: { readonly subpath: "slack"; readonly status: "stable"; readonly inboundApi: "Slack Events API"; readonly outboundApi: "Slack Web API"; readonly sdk: "none"; }; readonly github: { readonly subpath: "github"; readonly status: "stable"; read... | Published channel compatibility contract. Provider payload changes that only add fields are supported without a Fabric release; breaking provider versions are added here before becoming the default. |
ChannelCompatibility | type | ChannelCompatibility | Type contract for channel compatibility. |
channelCompatibilityPolicy | value | { readonly packageRule: "Adapters remain dependency-free subpaths unless a required SDK, runtime incompatibility, or independent release cadence requires a package."; readonly deprecationNoticeDays: 180; readonly removalRule: "Removal occurs only in a major release after... | Runtime API for channel compatibility policy; the generated signature shows its accepted inputs and return type. |
ChannelCompatibilityStatus | type | ChannelCompatibilityStatus | Type contract for channel compatibility status. |
ChannelContext | type | ChannelContext | Type contract for channel context. |
ChannelDispatch | type | ChannelDispatch | Type contract for channel dispatch. |
ChannelDispatchRequest | type | ChannelDispatchRequest | Input contract for channel dispatch. |
ChannelRoute | type | ChannelRoute | Channels turn platform webhooks (Slack, GitHub, …) into agent dispatches. Handlers are written against the Web Request/Response API and crypto.subtle, so the same channel runs on Node and Cloudflare. A channel is a stateless route container plus a conversation-id (de)serializer — session continuity falls out of the key (same thread → same key → same session). |
conversationKey | value | (provider: string, version: string, ...segments: string[]) => string | Runtime API for conversation key; the generated signature shows its accepted inputs and return type. |
defineChannel | value | (channel: Channel) => Channel | Validates and brands a channel's routes. |
FirstPartyChannelName | type | "slack" | "github" | "discord" | "teams" | "telegram" | "twilio" | "whatsapp" | "googleChat" | "linear" | "notion" | "stripe" | "zendesk" | "intercom" | "shopify" | "messenger" | "resend" | "salesforceMarketingCloud" | "buzz" | Type contract for first party channel name. |
hexToBytes | value | (hex: string) => Uint8Array | Runtime API for hex to bytes; the generated signature shows its accepted inputs and return type. |
hmacSha256 | value | (secret: string | Uint8Array, message: Uint8Array) => Promise<Uint8Array> | Runtime API for hmac sha256; the generated signature shows its accepted inputs and return type. |
parseConversationKey | value | (key: string) => ParsedConversationKey | Parses conversation key. |
ParsedConversationKey | type | ParsedConversationKey | Type contract for parsed conversation key. |
readRequestBody | value | (request: Request, limitBytes?: number) => Promise<Uint8Array | undefined> | Reads the full request body as bytes, or returns undefined if it exceeds limitBytes. NOTE: this consumes the request stream (single read). Signature-verifying channels need the exact bytes for HMAC and the parsed JSON afterward — don't call request.json() as well. Use readJsonBody to get both from one read. |
verifyHmacSha256 | value | (secret: string | Uint8Array, message: Uint8Array, signature: Uint8Array) => Promise<boolean> | Constant-time HMAC-SHA256 verification (via crypto.subtle.verify). |
@fabric-harness/channels/compatibility
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
channelCompatibility | value | { readonly slack: { readonly subpath: "slack"; readonly status: "stable"; readonly inboundApi: "Slack Events API"; readonly outboundApi: "Slack Web API"; readonly sdk: "none"; }; readonly github: { readonly subpath: "github"; readonly status: "stable"; read... | Published channel compatibility contract. Provider payload changes that only add fields are supported without a Fabric release; breaking provider versions are added here before becoming the default. |
ChannelCompatibility | type | ChannelCompatibility | Type contract for channel compatibility. |
channelCompatibilityPolicy | value | { readonly packageRule: "Adapters remain dependency-free subpaths unless a required SDK, runtime incompatibility, or independent release cadence requires a package."; readonly deprecationNoticeDays: 180; readonly removalRule: "Removal occurs only in a major release after... | Runtime API for channel compatibility policy; the generated signature shows its accepted inputs and return type. |
ChannelCompatibilityStatus | type | ChannelCompatibilityStatus | Type contract for channel compatibility status. |
FirstPartyChannelName | type | "slack" | "github" | "discord" | "teams" | "telegram" | "twilio" | "whatsapp" | "googleChat" | "linear" | "notion" | "stripe" | "zendesk" | "intercom" | "shopify" | "messenger" | "resend" | "salesforceMarketingCloud" | "buzz" | Type contract for first party channel name. |
@fabric-harness/channels/slack
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
createSlackChannel | value | (options: SlackChannelOptions) => SlackChannel | Slack events channel. Verifies the v0 HMAC signature, answers the URL-verification challenge, and dispatches app_mention / threaded message events to a persistent agent keyed by the Slack thread — with the Slack event_id as the dedupe key (exactly-once), the team as tenant, and the user as the acting actor (which is what powers on-behalf-of governance downstream). |
parseSlackConversationKey | value | (id: string) => SlackThreadRef | Parse a Slack instance id back into the thread ref (e.g. to bind replyInSlackThread at agent init). |
replyInSlackThread | value | (ref: SlackThreadRef, options: { botToken: string; fetchImpl?: typeof fetch; }) => ToolDef<{ text: string; }, unknown> | Outbound tool: reply in the Slack thread this agent is handling. |
SlackChannel | type | SlackChannel | Type contract for slack channel. |
SlackChannelOptions | type | SlackChannelOptions | Configuration options for slack channel. |
slackConversationKey | value | (ref: SlackThreadRef) => string | Serialize a Slack thread into the stable instance id used by createSlackChannel. |
SlackEvent | type | SlackEvent | Type contract for slack event. |
SlackEventsPayload | type | SlackEventsPayload | Type contract for slack events payload. |
SlackThreadRef | type | SlackThreadRef | Type contract for slack thread ref. |
@fabric-harness/channels/github
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
commentOnGitHubIssue | value | (ref: GitHubIssueRef, options: { token: string; fetchImpl?: typeof fetch; }) => ToolDef<{ text: string; }, unknown> | Outbound tool: comment on the GitHub issue / PR this agent is handling. |
createGitHubChannel | value | (options: GitHubChannelOptions) => GitHubChannel | GitHub webhook channel. Verifies the X-Hub-Signature-256 (sha256=<hex> HMAC over the raw body), and dispatches issue / PR / comment events to a persistent agent keyed by owner/repo/<kind>/<number> — with X-GitHub-Delivery as the dedupe key (exactly-once), the owner as tenant, and the sender as the acting actor. Bot senders are ignored to avoid loops; ping is acknowledged. |
GitHubChannel | type | GitHubChannel | Type contract for git hub channel. |
GitHubChannelOptions | type | GitHubChannelOptions | Configuration options for git hub channel. |
githubConversationKey | value | (ref: GitHubIssueRef) => string | Runtime API for github conversation key; the generated signature shows its accepted inputs and return type. |
GitHubIssueRef | type | GitHubIssueRef | Type contract for git hub issue ref. |
GitHubWebhookPayload | type | GitHubWebhookPayload | Type contract for git hub webhook payload. |
NormalizedGitHubEvent | type | NormalizedGitHubEvent | Type contract for normalized git hub event. |
normalizeGitHubEvent | value | (eventType: string, payload: GitHubWebhookPayload) => NormalizedGitHubEvent | undefined | Runtime API for normalize git hub event; the generated signature shows its accepted inputs and return type. |
parseGitHubConversationKey | value | (id: string) => GitHubIssueRef | Parses git hub conversation key. |
@fabric-harness/channels/discord
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
createDiscordChannel | value | (options: DiscordChannelOptions) => DiscordChannel | Creates discord channel. |
DiscordChannel | type | DiscordChannel | Type contract for discord channel. |
DiscordChannelOptions | type | DiscordChannelOptions | Configuration options for discord channel. |
discordConversationKey | value | (ref: DiscordConversationRef) => string | Runtime API for discord conversation key; the generated signature shows its accepted inputs and return type. |
DiscordConversationRef | type | DiscordConversationRef | Type contract for discord conversation ref. |
DiscordInteractionPayload | type | DiscordInteractionPayload | Type contract for discord interaction payload. |
parseDiscordConversationKey | value | (id: string) => DiscordConversationRef | Parses discord conversation key. |
replyInDiscord | value | (ref: DiscordConversationRef, options: { botToken: string; fetchImpl?: typeof fetch; }) => ToolDef<{ text: string; }, unknown> | Runtime API for reply in discord; the generated signature shows its accepted inputs and return type. |
verifyDiscordSignature | value | (publicKeyHex: string, timestamp: string, body: Uint8Array, signatureHex: string) => Promise<boolean> | Runtime API for verify discord signature; the generated signature shows its accepted inputs and return type. |
@fabric-harness/channels/teams
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
BotFrameworkAuthenticatorOptions | type | BotFrameworkAuthenticatorOptions | Configuration options for bot framework authenticator. |
createBotFrameworkAuthenticator | value | (options: BotFrameworkAuthenticatorOptions) => NonNullable<TeamsChannelOptions["authenticate"]> | Verify Microsoft Bot Connector signatures, issuer, audience, lifetime, service URL, and endorsement. |
createTeamsChannel | value | (options: TeamsChannelOptions) => TeamsChannel | Creates teams channel. |
parseTeamsConversationKey | value | (id: string) => TeamsConversationRef | Parses teams conversation key. |
replyInTeamsConversation | value | (ref: TeamsConversationRef, options: { accessToken: string | (() => string | Promise<string>); fetchImpl?: typeof fetch; }) => ToolDef<{ text: string; }, unknown> | Runtime API for reply in teams conversation; the generated signature shows its accepted inputs and return type. |
TeamsActivityPayload | type | TeamsActivityPayload | Type contract for teams activity payload. |
TeamsChannel | type | TeamsChannel | Type contract for teams channel. |
TeamsChannelOptions | type | TeamsChannelOptions | Configuration options for teams channel. |
teamsConversationKey | value | (ref: TeamsConversationRef) => string | Runtime API for teams conversation key; the generated signature shows its accepted inputs and return type. |
TeamsConversationRef | type | TeamsConversationRef | Type contract for teams conversation ref. |
@fabric-harness/channels/telegram
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
createTelegramChannel | value | (options: TelegramChannelOptions) => TelegramChannel | Creates telegram channel. |
parseTelegramConversationKey | value | (id: string) => TelegramConversationRef | Parses telegram conversation key. |
replyInTelegram | value | (ref: TelegramConversationRef, options: { botToken: string; fetchImpl?: typeof fetch; }) => ToolDef<{ text: string; }, unknown> | Runtime API for reply in telegram; the generated signature shows its accepted inputs and return type. |
TelegramChannel | type | TelegramChannel | Type contract for telegram channel. |
TelegramChannelOptions | type | TelegramChannelOptions | Configuration options for telegram channel. |
telegramConversationKey | value | (ref: TelegramConversationRef) => string | Runtime API for telegram conversation key; the generated signature shows its accepted inputs and return type. |
TelegramConversationRef | type | TelegramConversationRef | Type contract for telegram conversation ref. |
TelegramMessagePayload | type | TelegramMessagePayload | Type contract for telegram message payload. |
TelegramUpdatePayload | type | TelegramUpdatePayload | Type contract for telegram update payload. |
@fabric-harness/channels/twilio
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
createTwilioChannel | value | (options: TwilioChannelOptions) => TwilioChannel | Creates twilio channel. |
parseTwilioConversationKey | value | (id: string) => TwilioConversationRef | Parses twilio conversation key. |
replyWithTwilio | value | (ref: TwilioConversationRef, options: { authToken: string; fetchImpl?: typeof fetch; }) => ToolDef<{ text: string; }, unknown> | Runtime API for reply with twilio; the generated signature shows its accepted inputs and return type. |
TwilioChannel | type | TwilioChannel | Type contract for twilio channel. |
TwilioChannelOptions | type | TwilioChannelOptions | Configuration options for twilio channel. |
twilioConversationKey | value | (ref: TwilioConversationRef) => string | Runtime API for twilio conversation key; the generated signature shows its accepted inputs and return type. |
TwilioConversationRef | type | TwilioConversationRef | Type contract for twilio conversation ref. |
TwilioMessagePayload | type | TwilioMessagePayload | Type contract for twilio message payload. |
verifyTwilioSignature | value | (authToken: string, url: string, params: URLSearchParams, signature: string) => Promise<boolean> | Runtime API for verify twilio signature; the generated signature shows its accepted inputs and return type. |
@fabric-harness/channels/whatsapp
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
createWhatsAppChannel | value | (options: WhatsAppChannelOptions) => WhatsAppChannel | Creates whats app channel. |
parseWhatsAppConversationKey | value | (id: string) => WhatsAppConversationRef | Parses whats app conversation key. |
replyInWhatsApp | value | (ref: WhatsAppConversationRef, options: { accessToken: string; apiVersion?: string; fetchImpl?: typeof fetch; }) => ToolDef<{ text: string; }, unknown> | Runtime API for reply in whats app; the generated signature shows its accepted inputs and return type. |
WhatsAppChannel | type | WhatsAppChannel | Type contract for whats app channel. |
WhatsAppChannelOptions | type | WhatsAppChannelOptions | Configuration options for whats app channel. |
whatsAppConversationKey | value | (ref: WhatsAppConversationRef) => string | Runtime API for whats app conversation key; the generated signature shows its accepted inputs and return type. |
WhatsAppConversationRef | type | WhatsAppConversationRef | Type contract for whats app conversation ref. |
WhatsAppWebhookPayload | type | WhatsAppWebhookPayload | Type contract for whats app webhook payload. |
@fabric-harness/channels/google-chat
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
createGoogleChatChannel | value | (options: GoogleChatChannelOptions) => GoogleChatChannel | Creates google chat channel. |
GoogleChatChannel | type | GoogleChatChannel | Type contract for google chat channel. |
GoogleChatChannelOptions | type | GoogleChatChannelOptions | Configuration options for google chat channel. |
googleChatConversationKey | value | (ref: GoogleChatConversationRef) => string | Runtime API for google chat conversation key; the generated signature shows its accepted inputs and return type. |
GoogleChatConversationRef | type | GoogleChatConversationRef | Type contract for google chat conversation ref. |
GoogleChatEvent | type | GoogleChatEvent | Type contract for google chat event. |
parseGoogleChatConversationKey | value | (id: string) => GoogleChatConversationRef | Parses google chat conversation key. |
replyInGoogleChat | value | (ref: GoogleChatConversationRef, options: { accessToken: string; space: string; thread?: string; fetchImpl?: typeof fetch; }) => ToolDef<{ text: string; }, unknown> | Runtime API for reply in google chat; the generated signature shows its accepted inputs and return type. |
verifyGoogleChatRequest | value | (request: Request, options: { audience: string | readonly string[]; fetchImpl?: typeof fetch | undefined; now?: (() => number) | undefined; }) => Promise<boolean> | Input contract for verify google chat. |
@fabric-harness/channels/linear
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
commentOnLinearIssue | value | (ref: LinearConversationRef, options: { apiKey: string; issueId: string; fetchImpl?: typeof fetch; }) => ToolDef<{ text: string; }, unknown> | Runtime API for comment on linear issue; the generated signature shows its accepted inputs and return type. |
createLinearChannel | value | (options: LinearChannelOptions) => LinearChannel | Creates linear channel. |
LinearChannel | type | LinearChannel | Type contract for linear channel. |
LinearChannelOptions | type | LinearChannelOptions | Configuration options for linear channel. |
linearConversationKey | value | (ref: LinearConversationRef) => string | Runtime API for linear conversation key; the generated signature shows its accepted inputs and return type. |
LinearConversationRef | type | LinearConversationRef | Type contract for linear conversation ref. |
LinearWebhookPayload | type | LinearWebhookPayload | Type contract for linear webhook payload. |
parseLinearConversationKey | value | (id: string) => SimpleConversationRef | Parses linear conversation key. |
@fabric-harness/channels/notion
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
commentOnNotionPage | value | (ref: NotionConversationRef, options: { token: string; parentId: string; notionVersion?: string; fetchImpl?: typeof fetch; }) => ToolDef<{ text: string; }, unknown> | Runtime API for comment on notion page; the generated signature shows its accepted inputs and return type. |
createNotionChannel | value | (options: NotionChannelOptions) => NotionChannel | Creates notion channel. |
NotionChannel | type | NotionChannel | Type contract for notion channel. |
NotionChannelOptions | type | NotionChannelOptions | Configuration options for notion channel. |
notionConversationKey | value | (ref: NotionConversationRef) => string | Runtime API for notion conversation key; the generated signature shows its accepted inputs and return type. |
NotionConversationRef | type | NotionConversationRef | Type contract for notion conversation ref. |
NotionWebhookPayload | type | NotionWebhookPayload | Type contract for notion webhook payload. |
parseNotionConversationKey | value | (id: string) => SimpleConversationRef | Parses notion conversation key. |
@fabric-harness/channels/stripe
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
createStripeChannel | value | (options: StripeChannelOptions) => StripeChannel | Creates stripe channel. |
parseStripeConversationKey | value | (id: string) => SimpleConversationRef | Parses stripe conversation key. |
StripeChannel | type | StripeChannel | Type contract for stripe channel. |
StripeChannelOptions | type | StripeChannelOptions | Configuration options for stripe channel. |
stripeConversationKey | value | (ref: StripeConversationRef) => string | Runtime API for stripe conversation key; the generated signature shows its accepted inputs and return type. |
StripeConversationRef | type | StripeConversationRef | Type contract for stripe conversation ref. |
StripeEventPayload | type | StripeEventPayload | Type contract for stripe event payload. |
updateStripeCustomer | value | (ref: StripeConversationRef, options: { secretKey: string; customerId: string; fetchImpl?: typeof fetch; }) => ToolDef<{ description: string; }, unknown> | Runtime API for update stripe customer; the generated signature shows its accepted inputs and return type. |
verifyStripeSignature | value | (secret: string, raw: Uint8Array, header: string | null, options?: { toleranceSeconds?: number; now?: () => number; }) => Promise<boolean> | Runtime API for verify stripe signature; the generated signature shows its accepted inputs and return type. |
@fabric-harness/channels/zendesk
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
commentOnZendeskTicket | value | (ref: ZendeskConversationRef, options: { subdomain: string; token: string; email: string; ticketId: string | number; fetchImpl?: typeof fetch; }) => ToolDef<{ text: string; public?: boolean; }, unknown> | Runtime API for comment on zendesk ticket; the generated signature shows its accepted inputs and return type. |
createZendeskChannel | value | (options: ZendeskChannelOptions) => ZendeskChannel | Creates zendesk channel. |
parseZendeskConversationKey | value | (id: string) => SimpleConversationRef | Parses zendesk conversation key. |
ZendeskChannel | type | ZendeskChannel | Type contract for zendesk channel. |
ZendeskChannelOptions | type | ZendeskChannelOptions | Configuration options for zendesk channel. |
zendeskConversationKey | value | (ref: ZendeskConversationRef) => string | Runtime API for zendesk conversation key; the generated signature shows its accepted inputs and return type. |
ZendeskConversationRef | type | ZendeskConversationRef | Type contract for zendesk conversation ref. |
ZendeskWebhookPayload | type | ZendeskWebhookPayload | Type contract for zendesk webhook payload. |
@fabric-harness/channels/intercom
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
createIntercomChannel | value | (options: IntercomChannelOptions) => IntercomChannel | Creates intercom channel. |
IntercomChannel | type | IntercomChannel | Type contract for intercom channel. |
IntercomChannelOptions | type | IntercomChannelOptions | Configuration options for intercom channel. |
intercomConversationKey | value | (ref: IntercomConversationRef) => string | Runtime API for intercom conversation key; the generated signature shows its accepted inputs and return type. |
IntercomConversationRef | type | IntercomConversationRef | Type contract for intercom conversation ref. |
IntercomWebhookPayload | type | IntercomWebhookPayload | Type contract for intercom webhook payload. |
parseIntercomConversationKey | value | (id: string) => SimpleConversationRef | Parses intercom conversation key. |
replyInIntercom | value | (ref: IntercomConversationRef, options: { accessToken: string; conversationId: string; adminId: string; apiVersion?: string; fetchImpl?: typeof fetch; }) => ToolDef<{ text: string; }, unknown> | Runtime API for reply in intercom; the generated signature shows its accepted inputs and return type. |
@fabric-harness/channels/shopify
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
createShopifyChannel | value | (options: ShopifyChannelOptions) => ShopifyChannel | Creates shopify channel. |
parseShopifyConversationKey | value | (id: string) => SimpleConversationRef | Parses shopify conversation key. |
ShopifyChannel | type | ShopifyChannel | Type contract for shopify channel. |
ShopifyChannelOptions | type | ShopifyChannelOptions | Configuration options for shopify channel. |
shopifyConversationKey | value | (ref: ShopifyConversationRef) => string | Runtime API for shopify conversation key; the generated signature shows its accepted inputs and return type. |
ShopifyConversationRef | type | ShopifyConversationRef | Type contract for shopify conversation ref. |
ShopifyWebhookPayload | type | ShopifyWebhookPayload | Type contract for shopify webhook payload. |
updateShopifyOrderNote | value | (ref: ShopifyConversationRef, options: { shop: string; accessToken: string; orderId: string; apiVersion?: string; fetchImpl?: typeof fetch; }) => ToolDef<{ note: string; }, unknown> | Runtime API for update shopify order note; the generated signature shows its accepted inputs and return type. |
@fabric-harness/channels/messenger
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
createMessengerChannel | value | (options: MessengerChannelOptions) => MessengerChannel | Creates messenger channel. |
MessengerChannel | type | MessengerChannel | Type contract for messenger channel. |
MessengerChannelOptions | type | MessengerChannelOptions | Configuration options for messenger channel. |
messengerConversationKey | value | (ref: MessengerConversationRef) => string | Runtime API for messenger conversation key; the generated signature shows its accepted inputs and return type. |
MessengerConversationRef | type | MessengerConversationRef | Type contract for messenger conversation ref. |
MessengerWebhookPayload | type | MessengerWebhookPayload | Type contract for messenger webhook payload. |
parseMessengerConversationKey | value | (id: string) => MessengerConversationRef | Parses messenger conversation key. |
replyInMessenger | value | (ref: MessengerConversationRef, options: { pageAccessToken: string; apiVersion?: string; fetchImpl?: typeof fetch; }) => ToolDef<{ text: string; }, unknown> | Runtime API for reply in messenger; the generated signature shows its accepted inputs and return type. |
@fabric-harness/channels/resend
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
createResendChannel | value | (options: ResendChannelOptions) => ResendChannel | Creates resend channel. |
parseResendConversationKey | value | (id: string) => SimpleConversationRef | Parses resend conversation key. |
ResendChannel | type | ResendChannel | Type contract for resend channel. |
ResendChannelOptions | type | ResendChannelOptions | Configuration options for resend channel. |
resendConversationKey | value | (ref: ResendConversationRef) => string | Runtime API for resend conversation key; the generated signature shows its accepted inputs and return type. |
ResendConversationRef | type | ResendConversationRef | Type contract for resend conversation ref. |
ResendWebhookPayload | type | ResendWebhookPayload | Type contract for resend webhook payload. |
sendWithResend | value | (ref: ResendConversationRef, options: { apiKey: string; from: string; to: string; fetchImpl?: typeof fetch; }) => ToolDef<{ subject: string; text: string; }, unknown> | Runtime API for send with resend; the generated signature shows its accepted inputs and return type. |
verifyResendSignature | value | (secret: string, raw: Uint8Array, headers: Headers, options?: { toleranceSeconds?: number; now?: () => number; }) => Promise<boolean> | Runtime API for verify resend signature; the generated signature shows its accepted inputs and return type. |
@fabric-harness/channels/salesforce-marketing-cloud
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
createSalesforceMarketingCloudChannel | value | (options: SalesforceMarketingCloudChannelOptions) => SalesforceMarketingCloudChannel | Creates salesforce marketing cloud channel. |
parseSalesforceMarketingCloudConversationKey | value | (id: string) => SimpleConversationRef | Parses salesforce marketing cloud conversation key. |
SalesforceMarketingCloudChannel | type | SalesforceMarketingCloudChannel | Type contract for salesforce marketing cloud channel. |
SalesforceMarketingCloudChannelOptions | type | SalesforceMarketingCloudChannelOptions | Configuration options for salesforce marketing cloud channel. |
salesforceMarketingCloudConversationKey | value | (ref: SalesforceMarketingCloudConversationRef) => string | Runtime API for salesforce marketing cloud conversation key; the generated signature shows its accepted inputs and return type. |
SalesforceMarketingCloudConversationRef | type | SalesforceMarketingCloudConversationRef | Type contract for salesforce marketing cloud conversation ref. |
SalesforceMarketingCloudEvent | type | SalesforceMarketingCloudEvent | Type contract for salesforce marketing cloud event. |
SalesforceMarketingCloudWebhookPayload | type | SalesforceMarketingCloudWebhookPayload | Type contract for salesforce marketing cloud webhook payload. |
sendMarketingCloudMessage | value | (ref: SalesforceMarketingCloudConversationRef, options: { restBaseUrl: string; accessToken: string; definitionKey: string; recipient: string; fetchImpl?: typeof fetch; }) => ToolDef<{ attributes: Record<string, string>; }, unknown> | Runtime API for send marketing cloud message; the generated signature shows its accepted inputs and return type. |
@fabric-harness/channels/buzz
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
addBuzzReaction | value | (ref: BuzzThreadRef, config: BuzzPostConfig) => ToolDef<{ emoji: string; targetEventId: string; }, BuzzPostResult> | Outbound tool: add an emoji reaction to an event in the handled channel. |
BUZZ_PROTOCOL_SUPPORT | value | { readonly channelMessages: "dispatch"; readonly forumMessages: "dispatch"; readonly reactions: "dispatch"; readonly messageEdits: "observe-only"; readonly eventDeletions: "observe-only"; readonly reactionRemoval: "observe-only-no-decision-reversal"; readonly channelDelet... | Explicit product support policy for stock Buzz protocol surfaces. |
BuzzChannel | type | BuzzChannel | Type contract for buzz channel. |
BuzzChannelOptions | type | BuzzChannelOptions | Configuration options for buzz channel. |
buzzConversationKey | value | (ref: BuzzThreadRef) => string | Serialize a Buzz thread into the stable instance id used by createBuzzChannel. |
BuzzEnvelope | type | BuzzEnvelope | Type contract for buzz envelope. |
BuzzEvent | type | BuzzEvent | Nostr event shape (NIP-01). Kept local so the handler path stays SDK-only. |
buzzHttpUrl | value | (relayUrl: string) => string | Convert a relay WebSocket URL to its HTTP origin (Buzz serves both on one port). |
BuzzLifecycleNotice | type | BuzzLifecycleNotice | Content-free lifecycle evidence. Lifecycle events never enter model input and never reverse an immutable Platform decision. Applications may persist this through an operator/audit sink. |
BuzzLifecycleType | type | BuzzLifecycleType | Type contract for buzz lifecycle type. |
buzzNip98AuthHeader | value | (secretKeyHex: string, url: string, method: string, bodyText?: string, now?: () => number) => Promise<string> | Build the Authorization: Nostr <base64(kind-27235)> header for a Buzz HTTP-bridge request. Includes the payload sha256 tag when a body is given (NIP-98 SHOULD for POST; Buzz verifies it when present). Each call mints a fresh single-use event — the relay replay-guards by event id. |
BuzzPostConfig | type | BuzzPostConfig | Type contract for buzz post config. |
BuzzPostResult | type | BuzzPostResult | Result returned by buzz post. |
buzzPublicKey | value | (secretKeyHex: string) => string | Derive the adapter identity's public key from its secret key (64-char hex). |
BuzzRelayInfo | type | BuzzRelayInfo | NIP-11 relay information document (feature detection — plan §5.5). |
BuzzThreadRef | type | BuzzThreadRef | Type contract for buzz thread ref. |
classifyBuzzLifecycleEvent | value | (event: BuzzEvent, channelId?: string | undefined) => BuzzLifecycleNotice | undefined | Classify lifecycle kinds without inspecting or returning event content. |
createBuzzChannel | value | (options: BuzzChannelOptions) => BuzzChannel | Buzz events channel. Verifies the tail envelope HMAC (timestamped, replay bounded), verifies the inner event's Schnorr signature, normalizes stream messages / forum posts / reactions, and dispatches to a persistent agent keyed by (community, channel, thread root) — with the Nostr event id as the dedupe key (exactly-once), the community as tenant, and the author pubkey as the acting actor. |
createSignedBuzzEvent | value | (config: BuzzPostConfig, template: { kind: number; content: string; tags: string[][]; }) => BuzzEvent | Build the exact signed event that will be submitted to Buzz. |
parseBuzzConversationKey | value | (id: string) => BuzzThreadRef | Parse a Buzz instance id back into the thread ref. |
postBuzzDecisionRequest | value | (ref: BuzzThreadRef, config: BuzzPostConfig) => ToolDef<{ approvalRequestId: string; title: string; body: string; options?: string[]; }, BuzzPostResult> | Outbound tool: post a decision-request card. |
postInBuzzChannel | value | (ref: BuzzThreadRef, config: BuzzPostConfig) => ToolDef<{ text: string; }, BuzzPostResult> | Outbound tool: post a message in the Buzz channel this agent is handling. |
postSignedBuzzEvent | value | (config: BuzzPostConfig, template: { kind: number; content: string; tags: string[][]; }) => Promise<BuzzPostResult> | Sign a Buzz event with the adapter identity and submit it over the relay HTTP bridge. |
probeBuzzRelay | value | (relayUrl: string, fetchImpl?: typeof fetch, options?: { signal?: AbortSignal; requestTimeoutMs?: number; }) => Promise<BuzzRelayInfo> | Probe a Buzz relay's NIP-11 document. Detect features; never assume them. |
queryBuzzEvents | value | (config: BuzzPostConfig, filters: ReadonlyArray<Record<string, unknown>>) => Promise<BuzzEvent[]> | Authenticated HTTP-bridge query used by recovery and reconciliation paths. |
replyInBuzzThread | value | (ref: BuzzThreadRef, config: BuzzPostConfig) => ToolDef<{ text: string; }, BuzzPostResult> | Outbound tool: reply in the Buzz thread this agent is handling. |
signBuzzEnvelope | value | (secret: string, timestampSeconds: number, rawBody: string) => Promise<string> | Family signed-envelope standard: v1=hex(hmac-sha256(secret, "<ts>.<body>")). |
submitSignedBuzzEvent | value | (config: BuzzPostConfig, event: BuzzEvent) => Promise<BuzzPostResult> | Submit one already-signed event without changing its stable event id. |
verifyBuzzEvent | value | (event: BuzzEvent) => boolean | Verify a complete NIP-01 event id and Schnorr signature. |
@fabric-harness/channels/buzz-tail
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
BuzzCursorStore | type | BuzzCursorStore | Durable cursor persistence. Implementations must survive process restarts (file, database, durable object …). inMemoryBuzzCursorStore exists for tests and explicitly does NOT satisfy plan D15 in production. |
BuzzDeadLetterReason | type | BuzzDeadLetterReason | Type contract for buzz dead letter reason. |
BuzzDeadLetterRecord | type | BuzzDeadLetterRecord | Type contract for buzz dead letter record. |
BuzzDeadLetterStore | type | BuzzDeadLetterStore | Durable dead-letter backlog. Recording and reconciliation marking must be idempotent by event id; listing must return only unresolved records. |
BuzzTail | type | BuzzTail | Type contract for buzz tail. |
BuzzTailOperationalEvent | type | BuzzTailOperationalEvent | Content-free operational events suitable for metrics and certification evidence. |
BuzzTailOptions | type | BuzzTailOptions | Configuration options for buzz tail. |
inMemoryBuzzCursorStore | value | (initial?: number) => BuzzCursorStore & { current(): number | undefined; } | Test/development cursor store. Not durable — never use in production. |
reconcileBuzzDeadLetters | value | (options: ReconcileBuzzDeadLettersOptions) => Promise<{ attempted: number; reconciled: number; }> | Reconcile one bounded dead-letter batch. Records are acknowledged only after replay succeeds, so failed records remain visible for later repair. |
ReconcileBuzzDeadLettersOptions | type | ReconcileBuzzDeadLettersOptions | Configuration options for reconcile buzz dead letters. |
startBuzzTail | value | (options: BuzzTailOptions) => BuzzTail | Start tailing a Buzz relay with durable, ordered, at-least-once forwarding. |
@fabric-harness/channels/buzz-decisions
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
BUZZ_DECISION_EMOJI | value | Readonly<Record<string, "approve" | "reject">> | Fixed reaction→choice table (D14). NIP-25 +/- are included alongside the emoji the card legend shows. Anything else on a card is unmapped — surfaced for audit, never guessed. |
BuzzCardReceipt | type | BuzzCardReceipt | The binding between a posted card and its ApprovalRequest (plan §4 step 2). Stored by the trusted renderer beside the request; the bridge resolves reactions through it and through nothing else. |
BuzzCardReceiptStore | type | BuzzCardReceiptStore | Receipt lookup shared by ingress correlation and the deterministic bridge. |
BuzzDecisionBridgeOptions | type | BuzzDecisionBridgeOptions | Configuration options for buzz decision bridge. |
BuzzDecisionCandidate | type | BuzzDecisionCandidate | Type contract for buzz decision candidate. |
BuzzDecisionCardDelivery | type | BuzzDecisionCardDelivery | Durable outbox record for one canonical decision card. The exact signed event is persisted before relay I/O, making its Nostr id stable across retries and ambiguous network outcomes. |
buzzDecisionCardDeliveryKey | value | (community: string, channelId: string, approvalRequestId: string, requestVersion: number) => string | Stable logical identity for one request version on one Buzz surface. |
BuzzDecisionCardDeliveryStatus | type | BuzzDecisionCardDeliveryStatus | Type contract for buzz decision card delivery status. |
BuzzDecisionCardDeliveryStore | type | BuzzDecisionCardDeliveryStore | Production decision-card store. Implement this beside the vertical's ApprovalRequest. prepareDelivery is an immutable put-if-absent by deliveryKey and returns the existing record on retry. Publication marking must be idempotent. |
BuzzDecisionCardInput | type | BuzzDecisionCardInput | Deterministic, model-free decision surface for Buzz (Fabric Buzz Collaboration Plan D14; B1-H items 5–6). A signed reaction is mapped by trusted code from (community, channel, targetEventId) to exactly one immutable ApprovalRequest via a card receipt stored when the card was posted. A model may explain or acknowledge the result; it never selects the request, choice, principal, edits, or parameters. Free-form replies to a card are edit proposals — never approvals — until validated and explicitly confirmed through a structured decision path. Layering: this module performs zero autho... |
BuzzDecisionResolution | type | BuzzDecisionResolution | Type contract for buzz decision resolution. |
BuzzEditProposal | type | BuzzEditProposal | Type contract for buzz edit proposal. |
BuzzMessageInput | type | BuzzMessageInput | Normalized message input as dispatched by the Buzz channel route. |
BuzzReactionInput | type | BuzzReactionInput | Normalized reaction input as dispatched by the Buzz channel route. |
createBuzzDecisionBridge | value | (options: BuzzDecisionBridgeOptions) => { resolveReaction: (reaction: BuzzReactionInput) => Promise<BuzzDecisionResolution>; resolveReply: (message: BuzzMessageInput) => Promise<BuzzDecisionResolution>; } | The deterministic decision bridge (plan §4 steps 4–5). Pure lookup + fixed tables; no clock, no model, no authorization. Returns what the event is — the vertical's governed action decides what happens. |
inMemoryBuzzCardReceiptStore | value | () => BuzzDecisionCardDeliveryStore & { all(): BuzzCardReceipt[]; deliveries(): BuzzDecisionCardDelivery[]; } | Test/development receipt store. Not durable — never use in production. |
postBuzzDecisionCard | value | (ref: BuzzThreadRef, config: BuzzPostConfig & { deliveryStore: BuzzDecisionCardDeliveryStore; now?: () => number; }) => ToolDef<BuzzDecisionCardInput, BuzzCardReceipt> | Outbound tool: durably prepare the exact signed event + receipt, submit it, reconcile an ambiguous response by exact event id, then checkpoint publication. Returns the receipt. Posting a card grants nothing by itself. |
renderBuzzDecisionCard | value | (input: BuzzDecisionCardInput) => { content: string; tags: string[][]; } | Render the canonical decision card. Pure and deterministic: identical input yields byte-identical content and tags. The card's human-readable content is informational; all authority derives from the stored receipt, never from parsing this text back. |
@fabric-harness/channels/buzz-postgres
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
BuzzPostgresClient | type | BuzzPostgresClient | Structural client contract implemented by pg.Pool and Lakebase clients. |
BuzzPostgresHealth | type | BuzzPostgresHealth | Content-free operational evidence for one durable Buzz bridge consumer. |
BuzzPostgresPersistence | type | BuzzPostgresPersistence | Type contract for buzz postgres persistence. |
BuzzPostgresPersistenceOptions | type | BuzzPostgresPersistenceOptions | Configuration options for buzz postgres persistence. |
createPostgresBuzzPersistence | value | (options: BuzzPostgresPersistenceOptions) => BuzzPostgresPersistence | Create the durable Buzz bridge state used by PostgreSQL and Databricks Lakebase deployments. No pg dependency is loaded by the channels package; applications inject their existing pool/client. |
ensurePostgresBuzzTables | value | (client: BuzzPostgresClient, options?: { tablePrefix?: string; }) => Promise<void> | Runtime API for ensure postgres buzz tables; the generated signature shows its accepted inputs and return type. |
inspectPostgresBuzzHealth | value | (client: BuzzPostgresClient, options: InspectPostgresBuzzHealthOptions) => Promise<BuzzPostgresHealth> | Inspect durable Buzz bridge state without creating tables or reading event, dead-letter, or decision-card payloads. This is safe for read-only certification principals and returns only bounded operational counters. |
InspectPostgresBuzzHealthOptions | type | InspectPostgresBuzzHealthOptions | Configuration options for inspect postgres buzz health. |
@fabric-harness/channels/buzz-attestation
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
computeBuzzAuthTag | value | (ownerSecretKeyHex: string, agentPubkeyHex: string, conditions?: string) => string | Compute a NIP-OA auth tag as its canonical JSON-array string. Runs anywhere the adapter runs — no Rust toolchain needed for enrollment. Self-attestation (owner == agent) is rejected, matching the relay. |
parseBuzzAuthTag | value | (tagJson: string) => [string, string, string, string] | Parse and shape-check an auth-tag JSON string (from config/env) into the four-string tag array to attach to an AUTH event. Fails fast on malformed input so a mangled tag (the classic shell-sourced-.env bug) surfaces at startup, not as a silent 403 at the relay. |
validateBuzzAuthConditions | value | (conditions: string) => void | Validate a NIP-OA conditions string: empty, or &-joined clauses of kind=<0-65535>, created_at<<u32>, created_at><u32>. Canonical decimals only, no whitespace — mirrors buzz-sdk's validation so a tag we mint is a tag the relay accepts. |
@fabric-harness/channels/buzz-doctor
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
BuzzDiagnostic | type | BuzzDiagnostic | Type contract for buzz diagnostic. |
diagnoseBuzzConnection | value | (options: DiagnoseBuzzOptions) => Promise<BuzzDiagnostic[]> | Runtime API for diagnose buzz connection; the generated signature shows its accepted inputs and return type. |
DiagnoseBuzzOptions | type | DiagnoseBuzzOptions | Configuration options for diagnose buzz. |
formatBuzzDiagnostics | value | (diagnostics: BuzzDiagnostic[]) => string | Render diagnostics as aligned operator-readable lines. |
@fabric-harness/channels/buzz-media
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
BuzzAttachment | type | BuzzAttachment | Type contract for buzz attachment. |
buzzAttachmentMarkdown | value | (attachments: readonly BuzzAttachment[]) => string | Content lines that make attachments render inline:  /  for media MIME types, a plain markdown link otherwise. |
buzzImetaTags | value | (attachments: readonly BuzzAttachment[]) => string[][] | NIP-92 imeta tags, mirroring the desktop composer's field policy. |
uploadBuzzAttachment | value | (config: BuzzPostConfig, data: Uint8Array, options: { contentType: string; filename?: string; }) => Promise<BuzzAttachment> | Upload one attachment to the relay's Blossom endpoint. Returns the descriptor needed for buzzImetaTags / buzzAttachmentMarkdown. |
@fabric-harness/cli
@fabric-harness/cli
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
| No named exports |
@fabric-harness/cli/config
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
defineConfig | value | <T extends DefineConfigInput>(config: T) => T | Defines config. |
DefineConfigInput | type | DefineConfigInput | Type contract for define config input. |
@fabric-harness/cloudflare
@fabric-harness/cloudflare
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
cloudflare | value | (config: CloudflareBundleConfig) => CloudflareBundle | One-call wiring for a Cloudflare-native agent: model provider, Workers AI binding tools, a safe default egress policy, and an optional Durable Object session store. |
CLOUDFLARE_BUILD_TARGET | value | "cloudflare" | Constant defining cloudflare build target. |
CloudflareBundle | type | CloudflareBundle | Type contract for cloudflare bundle. |
CloudflareBundleConfig | type | CloudflareBundleConfig | Type contract for cloudflare bundle config. |
CloudflareCronHandlerOptions | type | CloudflareCronHandlerOptions<TEnv> | Configuration options for cloudflare cron handler. |
CloudflareDurableObjectNamespaceLike | type | CloudflareDurableObjectNamespaceLike | Type contract for cloudflare durable object namespace like. |
CloudflareDurableObjectSessionStoreOptions | type | CloudflareDurableObjectSessionStoreOptions | Configuration options for cloudflare durable object session store. |
CloudflareDurableObjectSqlStorage | type | CloudflareDurableObjectSqlStorage | Type contract for cloudflare durable object sql storage. |
CloudflareDurablePersistenceStores | type | CloudflareDurablePersistenceStores | Type contract for cloudflare durable persistence stores. |
CloudflareExecutionContextLike | type | CloudflareExecutionContextLike | Type contract for cloudflare execution context like. |
CloudflareExtension | type | CloudflareExtension | Type contract for cloudflare extension. |
CloudflareIndexedRun | type | CloudflareIndexedRun | Type contract for cloudflare indexed run. |
CloudflareIndexedRunStatus | type | CloudflareIndexedRunStatus | Type contract for cloudflare indexed run status. |
CloudflareR2BucketLike | type | CloudflareR2BucketLike | Type contract for cloudflare r2 bucket like. |
CloudflareR2ListResultLike | type | CloudflareR2ListResultLike | Type contract for cloudflare r2 list result like. |
CloudflareR2ObjectBodyLike | type | CloudflareR2ObjectBodyLike | Type contract for cloudflare r2 object body like. |
CloudflareRunListOptions | type | CloudflareRunListOptions | Configuration options for cloudflare run list. |
CloudflareRunListPage | type | CloudflareRunListPage | Type contract for cloudflare run list page. |
CloudflareRunRegistry | type | CloudflareRunRegistry | Type contract for cloudflare run registry. |
CloudflareRunRegistryClient | type | CloudflareRunRegistryClient | Client implementation for cloudflare run registry. |
CloudflareSandboxEnvOptions | type | CloudflareSandboxEnvOptions | Configuration options for cloudflare sandbox env. |
CloudflareSandboxExecResult | type | CloudflareSandboxExecResult | Result returned by cloudflare sandbox exec. |
CloudflareSandboxFileInfo | type | CloudflareSandboxFileInfo | Type contract for cloudflare sandbox file info. |
CloudflareSandboxLike | type | CloudflareSandboxLike | Type contract for cloudflare sandbox like. |
CloudflareSandboxProcessLike | type | CloudflareSandboxProcessLike | Type contract for cloudflare sandbox process like. |
CloudflareScheduledController | type | CloudflareScheduledController | Type contract for cloudflare scheduled controller. |
CloudflareScheduledJob | type | CloudflareScheduledJob | Type contract for cloudflare scheduled job. |
cloudflareScheduleIdempotencyKey | value | (job: string, expression: string, scheduledTime: number) => string | Runtime API for cloudflare schedule idempotency key; the generated signature shows its accepted inputs and return type. |
createCloudflareCronHandler | value | <TEnv = unknown>(options: CloudflareCronHandlerOptions<TEnv>) => (controller: CloudflareScheduledController, env: TEnv, context: CloudflareExecutionContextLike) => Promise<JobInvocationReceipt[]> | Build a Cloudflare scheduled() handler that admits matching jobs through the finite-run seam. |
createCloudflareDurableObjectSessionStore | value | (sql: CloudflareDurableObjectSqlStorage, options?: CloudflareDurableObjectSessionStoreOptions) => SessionStore | Minimal Durable Object SQL-backed SessionStore used by the Cloudflare build target. It intentionally depends only on the small SQL shape exposed by Workers Durable Objects so Cloudflare SDK types do not leak into the SDK. |
createCloudflareDurablePersistenceStores | value | (sql: CloudflareDurableObjectSqlStorage) => CloudflareDurablePersistenceStores | Durable Object SQLite stores for the v2 submission and stream lifecycle. |
createCloudflareRunRegistry | value | (sql: CloudflareDurableObjectSqlStorage) => CloudflareRunRegistry | Tenant-aware cross-Durable-Object index for finite job runs. Per-run Durable Objects remain authoritative. This index only stores the fields needed for discovery, so a registry outage cannot corrupt a run. |
createCloudflareRunRegistryClient | value | (namespace: CloudflareDurableObjectNamespaceLike | undefined) => CloudflareRunRegistryClient | undefined | Creates cloudflare run registry client. |
createCloudflareRunStore | value | (sql: CloudflareDurableObjectSqlStorage) => RunStore | Cloudflare Durable Object SQL-backed RunStore for workflow events. Enforces append-only semantics via a UNIQUE(run_id, event_index) primary key on the fabric_harness_workflow_events table. Duplicate event indexes for the same runId are rejected at the storage layer. A BEFORE INSERT trigger on fabric_harness_runs deletes existing events when a run is reset with the same id (same-ID reset behaviour). |
createCloudflareSandboxEnv | value | (sandbox: CloudflareSandboxLike, options?: CloudflareSandboxEnvOptions) => SandboxEnv | Adapt an instance returned by getSandbox(env.Sandbox, id) from @cloudflare/sandbox into Fabric's provider-neutral SandboxEnv contract. |
defineCloudflareAgent | value | <TInput = JsonObject, TOutput = unknown>(options?: DefineCloudflareAgentOptions<TInput, TOutput>) => DefinedAgent<TInput, TOutput> | Defines cloudflare agent. |
DefineCloudflareAgentOptions | type | DefineCloudflareAgentOptions<TInput, TOutput> | Configuration options for define cloudflare agent. |
extend | value | (extension: CloudflareExtension) => CloudflareExtension | Runtime API for extend; the generated signature shows its accepted inputs and return type. |
ExtensionClass | type | ExtensionClass | Type contract for extension class. |
handleCloudflareRunRegistryRequest | value | (registry: CloudflareRunRegistry, request: Request) => Promise<Response> | Handle the private protocol used between the generated Worker and registry DO. |
MockCloudflareModelProvider | value | typeof MockCloudflareModelProvider | A deterministic ModelProvider for Cloudflare agent tests and init templates. Returns structured responses without requiring real Cloudflare credentials. |
MockCloudflareModelProviderOptions | type | MockCloudflareModelProviderOptions | Configuration options for mock cloudflare model provider. |
r2FilesystemSource | value | (bucket: CloudflareR2BucketLike, options?: R2FilesystemSourceOptions) => FilesystemSource | Read Cloudflare R2 objects as a Fabric filesystem source. Mount it with withFilesystemSources() so support agents can grep/read R2-backed knowledge bases through the normal sandbox tools. |
R2FilesystemSourceOptions | type | R2FilesystemSourceOptions | Configuration options for r2 filesystem source. |
registerCloudflareSandboxRefDecoder | value | (connect: (data: { id: string; }) => Promise<CloudflareSandboxLike> | CloudflareSandboxLike) => void | Register cross-process/Worker attachment for Cloudflare Sandbox IDs. |
resolveCloudflareExtension | value | (mod: Record<string, unknown>, name: string, kind: "Agent" | "Workflow") => ResolvedCloudflareExtension | Resolves cloudflare extension. |
ResolvedCloudflareExtension | type | ResolvedCloudflareExtension | Type contract for resolved cloudflare extension. |
resolveToolRefs | value | (bundle: CloudflareBundle, refs: string[]) => ToolDef[] | Resolves tool refs. |
@fabric-harness/cloudflare/agent
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
defineCloudflareAgent | value | <TInput = JsonObject, TOutput = unknown>(options?: DefineCloudflareAgentOptions<TInput, TOutput>) => DefinedAgent<TInput, TOutput> | Defines cloudflare agent. |
DefineCloudflareAgentOptions | type | DefineCloudflareAgentOptions<TInput, TOutput> | Configuration options for define cloudflare agent. |
resolveToolRefs | value | (bundle: CloudflareBundle, refs: string[]) => ToolDef[] | Resolves tool refs. |
@fabric-harness/cloudflare/workers-ai
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
BUILTIN_WORKERS_AI_MODEL_INFO | value | Record<string, CloudflareWorkersAIModelInfo> | Constant defining builtin workers ai model info. |
CLOUDFLARE_WORKERS_AI_MODEL_PREFIX | value | "cloudflare/" | Reserved model-string prefix that routes through the Workers AI binding provider. init({ model: 'cloudflare/@cf/meta/llama-3.1-8b-instruct' }) picks this provider when one is registered with the matching name. |
CloudflareWorkersAIBindingLike | type | CloudflareWorkersAIBindingLike | Structural shape of Cloudflare Workers' AI binding (env.AI). The real Ai type lives in @cloudflare/workers-types; we accept a narrower structural type so this package doesn't peer-dep workers-types. The run() method accepts the OpenAI Chat Completions request body and returns an OpenAI-shaped response when stream: false is passed. |
CloudflareWorkersAIGatewayOptions | type | CloudflareWorkersAIGatewayOptions | Configuration options for cloudflare workers aigateway. |
CloudflareWorkersAIModelInfo | type | CloudflareWorkersAIModelInfo | Type contract for cloudflare workers aimodel info. |
CloudflareWorkersAIModelProvider | value | typeof CloudflareWorkersAIModelProvider | Model provider that dispatches to Cloudflare Workers AI via the platform binding (env.AI.run()) instead of HTTP. Use on a Cloudflare Workers deployment to skip API tokens, gain Workers-AI-native rate limiting, and keep inference inside Cloudflare's network. Workers AI accepts the OpenAI Chat Completions request body verbatim, so we serialize through the SDK's toOpenAIMessage/toOpenAITool helpers and parse the binding's response with openAIChatCompletionToModelResponse. See the package declarations for an example. Pair with the cloudflare/ model prefix to make routing explicit when... |
CloudflareWorkersAIModelProviderOptions | type | CloudflareWorkersAIModelProviderOptions | Configuration options for cloudflare workers aimodel provider. |
mapReasoningEffort | value | (level: Exclude<ThinkingLevel, "off">) => WorkersAIReasoningEffort | Map Fabric's ordinal ThinkingLevel to Cloudflare's shared reasoning_effort option: minimal/low → low, medium → medium, high/xhigh → high. 'off' is handled by the caller (the field is omitted) and never reaches this function. |
stripCloudflarePrefix | value | (model: string) => string | Strip the cloudflare/ routing prefix from a model id, leaving the raw Workers AI model id (e.g. @cf/meta/llama-3.1-8b-instruct). |
WorkersAIReasoningEffort | type | WorkersAIReasoningEffort | Cloudflare Workers AI reasoning-effort wire values. |
@fabric-harness/cloudflare/computer
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
CLOUDFLARE_COMPUTER_DEFAULT_CWD | value | "/workspace" | Constant defining cloudflare computer default cwd. |
CloudflareComputerContext | type | CloudflareComputerContext | Type contract for cloudflare computer context. |
CloudflareComputerSandboxEnv | type | CloudflareComputerSandboxEnv | Type contract for cloudflare computer sandbox env. |
CloudflareComputerSandboxOptions | type | CloudflareComputerSandboxOptions | Configuration options for cloudflare computer sandbox. |
CloudflareComputerWorkerLoaderLike | type | CloudflareComputerWorkerLoaderLike | Type contract for cloudflare computer worker loader like. |
cloudflareComputerWorkspace | value | (sandbox: SandboxEnv) => Workspace | Runtime API for cloudflare computer workspace; the generated signature shows its accepted inputs and return type. |
createCloudflareComputerSandboxEnv | value | (workspace: Workspace, options?: { cwd?: string; portableId?: string; }) => CloudflareComputerSandboxEnv | Creates cloudflare computer sandbox env. |
getCloudflareComputerContext | value | () => CloudflareComputerContext | Returns cloudflare computer context. |
getCloudflareComputerSandbox | value | (options?: CloudflareComputerSandboxOptions) => Promise<{ sandbox: CloudflareComputerSandboxEnv; tools: []; }> | Returns cloudflare computer sandbox. |
getCloudflareComputerWorkspaceStub | value | (id: string) => Promise<import("@cloudflare/computer").WorkspaceStub> | RPC endpoint used by Computer's WorkspaceServiceProxy and worker shell. |
getDefaultCloudflareComputerWorkspace | value | (options?: GetDefaultCloudflareComputerWorkspaceOptions) => Workspace | Return the memoized Computer workspace hosted by the current Durable Object. The wiring intentionally follows Cloudflare Computer's worker-shell topology: SQLite DO storage, a loopback WorkspaceServiceProxy, and the typed git client. |
GetDefaultCloudflareComputerWorkspaceOptions | type | GetDefaultCloudflareComputerWorkspaceOptions | Configuration options for get default cloudflare computer workspace. |
runWithCloudflareComputerContext | value | <T>(context: CloudflareComputerContext, fn: () => T) => T | Register the current Durable Object as the host for its Computer workspace. |
Workspace | value | typeof Workspace | Runtime API for workspace; the generated signature shows its accepted inputs and return type. |
WorkspaceOptions | type | WorkspaceOptions | Configuration options for workspace. |
WorkspaceServiceProxy | value | typeof WorkspaceServiceProxy | Runtime API for workspace service proxy; the generated signature shows its accepted inputs and return type. |
@fabric-harness/cloudflare/shell
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
CloudflareShellCodeExecutorLike | type | CloudflareShellCodeExecutorLike | Type contract for cloudflare shell code executor like. |
CloudflareShellCodeInput | type | CloudflareShellCodeInput | Type contract for cloudflare shell code input. |
CloudflareShellCodeToolOptions | type | CloudflareShellCodeToolOptions | Configuration options for cloudflare shell code tool. |
CloudflareShellContext | type | CloudflareShellContext | Type contract for cloudflare shell context. |
CloudflareShellWorkspaceSandbox | type | CloudflareShellWorkspaceSandbox | Sandbox adapter for cloudflare shell workspace. |
CloudflareShellWorkspaceSandboxOptions | type | CloudflareShellWorkspaceSandboxOptions | Configuration options for cloudflare shell workspace sandbox. |
CloudflareWorkerLoaderLike | type | CloudflareWorkerLoaderLike | Type contract for cloudflare worker loader like. |
createCloudflareShellCodeTool | value | (options: CloudflareShellCodeToolOptions) => Promise<ToolDef<CloudflareShellCodeInput, string>> | Creates cloudflare shell code tool. |
createCloudflareShellCodeToolFromExecutor | value | (executor: CloudflareShellCodeExecutorLike, stateProvider: ResolvedProvider, options?: { stateTypes?: string; }) => ToolDef<CloudflareShellCodeInput, string> | Creates cloudflare shell code tool from executor. |
createCloudflareShellWorkspaceSandboxEnv | value | (workspace: Workspace, options?: { cwd?: string; portableId?: string; }) => Promise<SandboxEnv> | Creates cloudflare shell workspace sandbox env. |
getCloudflareShellContext | value | () => CloudflareShellContext | Returns cloudflare shell context. |
getCloudflareShellWorkspaceSandbox | value | (options: CloudflareShellWorkspaceSandboxOptions) => Promise<CloudflareShellWorkspaceSandbox> | Returns cloudflare shell workspace sandbox. |
getDefaultCloudflareWorkspace | value | (options?: GetDefaultCloudflareWorkspaceOptions) => Promise<Workspace> | Construct the default |
GetDefaultCloudflareWorkspaceOptions | type | GetDefaultCloudflareWorkspaceOptions | Configuration options for get default cloudflare workspace. |
hydrateCloudflareWorkspaceFromR2 | value | (workspace: Pick<Workspace, "writeFileBytes">, bucket: Pick<CloudflareR2BucketLike, "list" | "get">, options?: HydrateCloudflareWorkspaceFromR2Options) => Promise<void> | Eagerly copy R2 objects into a |
HydrateCloudflareWorkspaceFromR2Options | type | HydrateCloudflareWorkspaceFromR2Options | Configuration options for hydrate cloudflare workspace from r2. |
registerCloudflareShellWorkspaceRefDecoder | value | (connect: (data: { workspaceId: string; }) => Promise<Workspace> | Workspace) => void | Register attachment for a durable Cloudflare Shell workspace routing ID. |
runWithCloudflareShellContext | value | <T>(context: CloudflareShellContext, fn: () => T) => T | Runs with cloudflare shell context. |
@fabric-harness/cloudflare/scheduled
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
CloudflareCronHandlerOptions | type | CloudflareCronHandlerOptions<TEnv> | Configuration options for cloudflare cron handler. |
CloudflareExecutionContextLike | type | CloudflareExecutionContextLike | Type contract for cloudflare execution context like. |
CloudflareScheduledController | type | CloudflareScheduledController | Type contract for cloudflare scheduled controller. |
CloudflareScheduledJob | type | CloudflareScheduledJob | Type contract for cloudflare scheduled job. |
cloudflareScheduleIdempotencyKey | value | (job: string, expression: string, scheduledTime: number) => string | Runtime API for cloudflare schedule idempotency key; the generated signature shows its accepted inputs and return type. |
createCloudflareCronHandler | value | <TEnv = unknown>(options: CloudflareCronHandlerOptions<TEnv>) => (controller: CloudflareScheduledController, env: TEnv, context: CloudflareExecutionContextLike) => Promise<JobInvocationReceipt[]> | Build a Cloudflare scheduled() handler that admits matching jobs through the finite-run seam. |
@fabric-harness/cloudflare/persistence
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
CloudflareDurablePersistenceStores | type | CloudflareDurablePersistenceStores | Type contract for cloudflare durable persistence stores. |
createCloudflareDurablePersistenceStores | value | (sql: CloudflareDurableObjectSqlStorage) => CloudflareDurablePersistenceStores | Durable Object SQLite stores for the v2 submission and stream lifecycle. |
@fabric-harness/connectors
@fabric-harness/connectors
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
assertRetainableSandboxCertification | value | (report: SandboxCertificationReport, expectation: RetainedSandboxCertificationExpectation) => SandboxCertificationReport | Fail closed before a credentialed report is retained as release evidence. |
assertSandboxCertification | value | (env: SandboxEnv, options: SandboxCertificationOptions) => Promise<SandboxCertificationReport> | Validates sandbox certification and throws when the requirement is not met. |
AzureBlobBodyLike | type | AzureBlobBodyLike | Type contract for azure blob body like. |
AzureBlobFilesystemClientLike | type | AzureBlobFilesystemClientLike | Type contract for azure blob filesystem client like. |
azureBlobFilesystemSource | value | (client: AzureBlobFilesystemClientLike, options?: ObjectStorageFilesystemSourceOptions) => FilesystemSource | Data or filesystem source for azure blob filesystem. |
AzureBlobListResultLike | type | AzureBlobListResultLike | Type contract for azure blob list result like. |
certifySandboxAdapter | value | (env: SandboxEnv, options: SandboxCertificationOptions) => Promise<SandboxCertificationReport> | Exercise the portable Fabric sandbox contract and return secret-free, machine-readable evidence suitable for a CI artifact. |
daytonaSandbox | value | (sandbox: DaytonaSandboxLike, options?: DaytonaSandboxOptions) => SandboxEnv | Sandbox adapter for daytona. |
daytonaSandboxFactory | value | (sandbox: DaytonaSandboxLike, options?: DaytonaSandboxOptions) => Promise<SandboxFactory> | Factory for daytona sandbox. |
DaytonaSandboxLike | type | DaytonaSandboxLike | Type contract for daytona sandbox like. |
DaytonaSandboxOptions | type | DaytonaSandboxOptions | Configuration options for daytona sandbox. |
e2bSandbox | value | (sandbox: E2BSandboxLike, options?: RemoteAdapterOptions) => SandboxEnv | Sandbox adapter for e2b. |
E2BSandboxLike | type | E2BSandboxLike | Type contract for e2 bsandbox like. |
FilesystemSource | type | FilesystemSource | A read-only content source that can be mounted into a sandbox at sandbox-creation time. The agent then has built-in read, glob, and grep tools available over the mounted content — no retrieval pipeline, no embeddings, no vector store required. Sources are intentionally minimal: they yield (path, content) pairs. Implementations decide how to enumerate (eager vs lazy is up to the source author) — the mount step pulls the full set into the sandbox. |
ModalFileInfoLike | type | ModalFileInfoLike | Type contract for modal file info like. |
ModalFilesystemLike | type | ModalFilesystemLike | Type contract for modal filesystem like. |
ModalProcessLike | type | ModalProcessLike | Type contract for modal process like. |
ModalReadStreamLike | type | ModalReadStreamLike<T> | Type contract for modal read stream like. |
modalSandbox | value | (sandbox: ModalSandboxLike, options?: RemoteAdapterOptions) => SandboxEnv | Sandbox adapter for modal. |
ModalSandboxLike | type | ModalSandboxLike | Type contract for modal sandbox like. |
modalSdkSandbox | value | (sandbox: ModalSdkSandboxLike, options?: ModalSdkSandboxOptions) => SandboxEnv | Adapt a native Modal TypeScript SDK Sandbox without exposing credentials to the Fabric runtime or model context. |
ModalSdkSandboxLike | type | ModalSdkSandboxLike | Structural subset implemented by modal 0.9 Sandbox. |
ModalSdkSandboxOptions | type | ModalSdkSandboxOptions | Configuration options for modal sdk sandbox. |
ObjectStorageFilesystemSourceOptions | type | ObjectStorageFilesystemSourceOptions | Configuration options for object storage filesystem source. |
ProviderCleanupOptions | type | ProviderCleanupOptions | Configuration options for provider cleanup. |
RemoteAdapterOptions | type | RemoteAdapterOptions | Configuration options for remote adapter. |
remoteSandbox | value | (api: RemoteSandboxApi, options?: RemoteSandboxConnectorOptions) => SandboxFactory | Dependency-free structural connector for provider-owned remote sandboxes. Provider-specific packages can keep their SDK/client types private and map them to RemoteSandboxApi, then return this SandboxFactory. Credentials stay in the provider client and are never serialized into Fabric session history. |
RemoteSandboxApi | type | RemoteSandboxApi | Type contract for remote sandbox api. |
RemoteSandboxConnectorOptions | type | RemoteSandboxConnectorOptions | Configuration options for remote sandbox connector. |
remoteSandboxEnv | value | (api: RemoteSandboxApi, options?: RemoteAdapterOptions) => SandboxEnv | Runtime API for remote sandbox env; the generated signature shows its accepted inputs and return type. |
RemoteSandboxOptions | type | RemoteSandboxOptions | Configuration options for remote sandbox. |
RetainedSandboxCertificationExpectation | type | RetainedSandboxCertificationExpectation | Type contract for retained sandbox certification expectation. |
S3FilesystemClientLike | type | S3FilesystemClientLike | Type contract for s3 filesystem client like. |
s3FilesystemSource | value | (client: S3FilesystemClientLike, options?: ObjectStorageFilesystemSourceOptions) => FilesystemSource | Data or filesystem source for s3 filesystem. |
S3ObjectBodyLike | type | S3ObjectBodyLike | Type contract for s3 object body like. |
S3ObjectListResultLike | type | S3ObjectListResultLike | Type contract for s3 object list result like. |
SANDBOX_CERTIFICATION_CHECKS | value | readonly SandboxCertificationCheckName[] | Constant defining sandbox certification checks. |
SANDBOX_PROVIDER_COMPATIBILITY | value | { readonly daytona: { readonly package: "@daytona/sdk"; readonly range: ">=0.195.0 <1"; readonly supportedMajors: readonly [0]; readonly tested: readonly ["0.195.0"]; }; readonly e2b: { readonly package: "@e2b/code-interpreter"; readonly range: ">=... | Constant defining sandbox provider compatibility. |
SandboxAdapterValidationOptions | type | SandboxAdapterValidationOptions | Configuration options for sandbox adapter validation. |
SandboxAdapterValidationResult | type | SandboxAdapterValidationResult | Result returned by sandbox adapter validation. |
SandboxCertificationCheck | type | SandboxCertificationCheck | Type contract for sandbox certification check. |
SandboxCertificationCheckName | type | SandboxCertificationCheckName | Type contract for sandbox certification check name. |
SandboxCertificationError | value | typeof SandboxCertificationError | Error raised for sandbox certification failures. |
SandboxCertificationOptions | type | SandboxCertificationOptions | Configuration options for sandbox certification. |
SandboxCertificationReport | type | SandboxCertificationReport | Type contract for sandbox certification report. |
SandboxFactory | type | SandboxFactory | Factory for sandbox. |
validateSandboxAdapter | value | (env: SandboxEnv, options?: SandboxAdapterValidationOptions) => Promise<SandboxAdapterValidationResult> | Runtime API for validate sandbox adapter; the generated signature shows its accepted inputs and return type. |
@fabric-harness/connectors/s3
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
s3Source | value | (options: S3SourceOptions) => FilesystemSource | Read-only S3 connector. Mount with session.mount(mountAt, s3Source(...)). The agent's built-in read, grep, glob, and bash tools then operate over the mounted prefix as if it were a local directory. |
S3SourceOptions | type | S3SourceOptions | Concrete S3 connector backed by @aws-sdk/client-s3. Users pass bucket config; this module constructs the SDK client internally and adapts it to Fabric Harness's FilesystemSource contract. Install peer dep: ```sh npm install |
s3Writer | value | (options: S3WriterOptions) => S3Writer | Writer implementation for s3. |
S3Writer | type | S3Writer | Writer implementation for s3. |
S3WriterOptions | type | S3WriterOptions | Write-side helper for S3. Use to publish artifacts or mount a writable view. See the package declarations for an example. |
@fabric-harness/connectors/azure-blob
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
azureBlobSource | value | (options: AzureBlobSourceOptions) => FilesystemSource | Data or filesystem source for azure blob. |
AzureBlobSourceOptions | type | AzureBlobSourceOptions | Concrete Azure Blob connector backed by @azure/storage-blob. Install peer deps: ```sh npm install |
azureBlobWriter | value | (options: AzureBlobWriterOptions) => AzureBlobWriter | Writer implementation for azure blob. |
AzureBlobWriter | type | AzureBlobWriter | Writer implementation for azure blob. |
AzureBlobWriterOptions | type | AzureBlobWriterOptions | Configuration options for azure blob writer. |
@fabric-harness/connectors/gcs
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
gcsSource | value | (options: GcsSourceOptions) => FilesystemSource | Data or filesystem source for gcs. |
GcsSourceOptions | type | GcsSourceOptions | Concrete Google Cloud Storage connector backed by @google-cloud/storage. Install peer dep: ```sh npm install |
gcsWriter | value | (options: GcsWriterOptions) => GcsWriter | Writer implementation for gcs. |
GcsWriter | type | GcsWriter | Writer implementation for gcs. |
GcsWriterOptions | type | GcsWriterOptions | Configuration options for gcs writer. |
@fabric-harness/connectors/github
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
githubSource | value | (options: GithubSourceOptions) => FilesystemSource | Data or filesystem source for github. |
GithubSourceOptions | type | GithubSourceOptions | Read-only GitHub repository connector backed by octokit. Mounts a repository (at a given ref) as files inside the sandbox. Uses the Git Trees API in recursive mode for efficient enumeration. Install peer dep: See the package declarations for an example. |
@fabric-harness/connectors/databricks-volume
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
databricksVolumeSource | value | (options: DatabricksVolumeSourceOptions) => FilesystemSource | Data or filesystem source for databricks volume. |
DatabricksVolumeSourceOptions | type | DatabricksVolumeSourceOptions | Databricks Unity Catalog Volume connector backed by the Files API (/api/2.0/fs/files/...). No SDK dependency — uses fetch directly. Volume paths are addressed as /Volumes/<catalog>/<schema>/<volume>/<path>. Usage: See the package declarations for an example. |
databricksVolumeWriter | value | (options: DatabricksVolumeWriterOptions) => DatabricksVolumeWriter | Writer implementation for databricks volume. |
DatabricksVolumeWriter | type | DatabricksVolumeWriter | Writer implementation for databricks volume. |
DatabricksVolumeWriterOptions | type | DatabricksVolumeWriterOptions | Configuration options for databricks volume writer. |
@fabric-harness/connectors/k8s
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
createKubernetesEgressNetworkPolicy | value | (options: KubernetesEgressNetworkPolicyOptions) => KubernetesNetworkPolicyManifest | Build a deny-by-default Kubernetes egress boundary. Domain filtering belongs in the selected proxy; Kubernetes NetworkPolicy is intentionally limited to DNS, that proxy, and explicit private endpoint CIDRs. |
createKubernetesPod | value | (options: CreateKubernetesPodOptions) => KubernetesPodLike | Creates kubernetes pod. |
createKubernetesPodFromImage | value | (options: CreateKubernetesPodFromImageOptions) => Promise<KubernetesPodLike> | Creates kubernetes pod from image. |
CreateKubernetesPodFromImageOptions | type | CreateKubernetesPodFromImageOptions | Provision an ephemeral pod from an image and return a KubernetesPodLike ready for kubernetesSandbox(). Works against any cluster reachable via the resolved kubeconfig — in-cluster, $KUBECONFIG, or ~/.kube/config. The pod is created with restartPolicy: Never and runs sleep infinity so it stays attachable. cleanup() (when wired via kubernetesSandbox's cleanup: true) deletes the pod. For Azure-managed clusters, prefer aksSandbox() from @fabric-harness/azure/aks-sandbox which adds ARM-resolved kubeconfig. See the package declarations for an example. |
CreateKubernetesPodOptions | type | CreateKubernetesPodOptions | Convenience helper: build a KubernetesPodLike from a @kubernetes/client-node KubeConfig plus pod identity. Suitable when kubectl already gets you in the door — for AKS, prefer aksSandbox() from @fabric-harness/azure. Files are transferred over exec using base64-encoded cat / tee. Works for text and small binaries; for large objects mount external storage via s3Source / gcsSource / azureBlobSource instead. |
KubernetesEgressNetworkPolicyOptions | type | KubernetesEgressNetworkPolicyOptions | Configuration options for kubernetes egress network policy. |
KubernetesNetworkPolicyManifest | type | KubernetesNetworkPolicyManifest | Type contract for kubernetes network policy manifest. |
KubernetesPodLike | type | KubernetesPodLike | Structural Kubernetes pod adapter. The caller wires up @kubernetes/client-node (or any SPDY/exec-capable client) and supplies an object that satisfies KubernetesPodLike. Why structural: cluster auth, RBAC, and the exec wire format vary too much across environments (in-cluster, kubeconfig, AKS managed identity, GKE Workload Identity, EKS IRSA, …) for a single concrete adapter to be sensible. Pattern matches daytonaSandbox / e2bSandbox. For Azure-hosted clusters use the higher-level aksSandbox() from @fabric-harness/azure, which wires this adapter to Azure-managed credentials. |
kubernetesSandbox | value | (pod: KubernetesPodLike, options?: KubernetesSandboxOptions) => SandboxEnv | Sandbox adapter for kubernetes. |
KubernetesSandboxOptions | type | KubernetesSandboxOptions | Configuration options for kubernetes sandbox. |
@fabric-harness/connectors/vercel
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
vercelSandbox | value | (sandbox: VercelSandboxLike, options?: VercelSandboxOptions) => SandboxEnv | Wrap a Vercel Sandbox instance as a Fabric Harness SandboxEnv. The sandbox's filesystem and shell exec are mapped to the fabric contract; cleanup: true calls sandbox.stop() when the Fabric session tears down. See the package declarations for an example. Vercel's runCommand accepts cwd, env, AbortSignal, and output streams. Fabric maps its millisecond timeout to an AbortSignal and resolves the command object's async stdout()/stderr() methods used by SDK 1.x. |
vercelSandboxFactory | value | (create: () => Promise<VercelSandboxLike> | VercelSandboxLike, options?: VercelSandboxOptions) => SandboxFactory | Convenience factory that returns a SandboxFactory, suitable for init({ sandbox: vercelSandboxFactory(...) }). Provisions a fresh sandbox on first use via the supplied create() callback. |
VercelSandboxLike | type | VercelSandboxLike | Structural shape of @vercel/sandbox's Sandbox instance, kept narrow so this package doesn't peer-dep on @vercel/sandbox directly. Pass any object satisfying this contract — the real Sandbox from @vercel/sandbox does. See https://vercel.com/docs/vercel-sandbox/sdk-reference for the upstream API. This adapter targets the post-GA shape (runCommand, fs.*). |
VercelSandboxOptions | type | VercelSandboxOptions | Configuration options for vercel sandbox. |
@fabric-harness/connectors/modal
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
ModalFileInfoLike | type | ModalFileInfoLike | Type contract for modal file info like. |
ModalFilesystemLike | type | ModalFilesystemLike | Type contract for modal filesystem like. |
ModalProcessLike | type | ModalProcessLike | Type contract for modal process like. |
ModalReadStreamLike | type | ModalReadStreamLike<T> | Type contract for modal read stream like. |
modalSdkSandbox | value | (sandbox: ModalSdkSandboxLike, options?: ModalSdkSandboxOptions) => SandboxEnv | Adapt a native Modal TypeScript SDK Sandbox without exposing credentials to the Fabric runtime or model context. |
ModalSdkSandboxLike | type | ModalSdkSandboxLike | Structural subset implemented by modal 0.9 Sandbox. |
ModalSdkSandboxOptions | type | ModalSdkSandboxOptions | Configuration options for modal sdk sandbox. |
@fabric-harness/connectors/sandbox-refs
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
RegisterStandardDecodersOptions | type | RegisterStandardDecodersOptions | Standard cross-process sandbox-ref decoders for the connectors that ship here. Call this once at startup in any process that needs to attach to sandboxes encoded by session.sandboxRef({ portable: true }). Each connect* callback is responsible for hydrating a provider-native client object from providerData; the connectors package wraps that client in a SandboxEnv exactly the way the upstream factory functions do (daytonaSandbox, e2bSandbox, modalSandbox, kubernetesSandbox). See the package declarations for an example. |
registerStandardSandboxRefDecoders | value | (options: RegisterStandardDecodersOptions) => void | Registers standard sandbox ref decoders. |
@fabric-harness/connectors/sandbox-certification
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
assertRetainableSandboxCertification | value | (report: SandboxCertificationReport, expectation: RetainedSandboxCertificationExpectation) => SandboxCertificationReport | Fail closed before a credentialed report is retained as release evidence. |
assertSandboxCertification | value | (env: SandboxEnv, options: SandboxCertificationOptions) => Promise<SandboxCertificationReport> | Validates sandbox certification and throws when the requirement is not met. |
certifySandboxAdapter | value | (env: SandboxEnv, options: SandboxCertificationOptions) => Promise<SandboxCertificationReport> | Exercise the portable Fabric sandbox contract and return secret-free, machine-readable evidence suitable for a CI artifact. |
RetainedSandboxCertificationExpectation | type | RetainedSandboxCertificationExpectation | Type contract for retained sandbox certification expectation. |
SANDBOX_CERTIFICATION_CHECKS | value | readonly SandboxCertificationCheckName[] | Constant defining sandbox certification checks. |
SandboxCertificationCheck | type | SandboxCertificationCheck | Type contract for sandbox certification check. |
SandboxCertificationCheckName | type | SandboxCertificationCheckName | Type contract for sandbox certification check name. |
SandboxCertificationError | value | typeof SandboxCertificationError | Error raised for sandbox certification failures. |
SandboxCertificationOptions | type | SandboxCertificationOptions | Configuration options for sandbox certification. |
SandboxCertificationReport | type | SandboxCertificationReport | Type contract for sandbox certification report. |
@fabric-harness/databases
@fabric-harness/databases
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
assertReadOnlyStatement | value | (statement: string) => void | Validates read only statement and throws when the requirement is not met. |
governedDatabaseTool | value | <TInput, TOutput>(options: GovernedDatabaseToolOptions<TInput, TOutput>) => ToolDef<TInput, TOutput> | Common database tool boundary: effect metadata, timeout, size cap, and redacted failures. |
GovernedDatabaseToolOptions | type | GovernedDatabaseToolOptions<TInput, TOutput> | Configuration options for governed database tool. |
MongoCollectionLike | type | MongoCollectionLike<T> | Type contract for mongo collection like. |
MongoCursorLike | type | MongoCursorLike<T> | Type contract for mongo cursor like. |
mongoFindTool | value | <TInput = JsonObject, TDocument = JsonObject>(options: MongoFindToolOptions<TInput, TDocument>) => ToolDef<TInput, { documents: TDocument[]; }> | Collection-bound find tool. Host code constructs the filter and projection. |
MongoFindToolOptions | type | MongoFindToolOptions<TInput, TDocument> | Configuration options for mongo find tool. |
MysqlClientLike | type | MysqlClientLike | Type contract for mysql client like. |
mysqlTool | value | <TInput = JsonObject, TRow = JsonObject>(options: MysqlToolOptions<TInput, TRow>) => ToolDef<TInput, { rows: TRow[]; }> | Model-callable tool or tool factory for mysql. |
MysqlToolOptions | type | MysqlToolOptions<TInput, TRow> | Configuration options for mysql tool. |
PostgresClientLike | type | PostgresClientLike | Type contract for postgres client like. |
postgresTool | value | <TInput = JsonObject, TRow = JsonObject>(options: PostgresToolOptions<TInput, TRow>) => ToolDef<TInput, { rows: TRow[]; rowCount: number; }> | Fixed-statement Postgres tool. The model supplies values, never SQL text. |
PostgresToolOptions | type | PostgresToolOptions<TInput, TRow> | Configuration options for postgres tool. |
RedisClientLike | type | RedisClientLike | Type contract for redis client like. |
RedisToolOptions | type | RedisToolOptions | Configuration options for redis tool. |
redisTools | value | (options: RedisToolOptions) => Array<ToolDef> | Runtime API for redis tools; the generated signature shows its accepted inputs and return type. |
SqliteClientLike | type | SqliteClientLike | Type contract for sqlite client like. |
SqliteStatementLike | type | SqliteStatementLike | Type contract for sqlite statement like. |
sqliteTool | value | <TInput = JsonObject, TRow = JsonObject>(options: SqliteToolOptions<TInput, TRow>) => ToolDef<TInput, { rows?: TRow[]; result?: unknown; }> | Model-callable tool or tool factory for sqlite. |
SqliteToolOptions | type | SqliteToolOptions<TInput, TRow> | Configuration options for sqlite tool. |
@fabric-harness/databases/postgres
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
PostgresClientLike | type | PostgresClientLike | Type contract for postgres client like. |
postgresTool | value | <TInput = JsonObject, TRow = JsonObject>(options: PostgresToolOptions<TInput, TRow>) => ToolDef<TInput, { rows: TRow[]; rowCount: number; }> | Fixed-statement Postgres tool. The model supplies values, never SQL text. |
PostgresToolOptions | type | PostgresToolOptions<TInput, TRow> | Configuration options for postgres tool. |
@fabric-harness/databases/mysql
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
MysqlClientLike | type | MysqlClientLike | Type contract for mysql client like. |
mysqlTool | value | <TInput = JsonObject, TRow = JsonObject>(options: MysqlToolOptions<TInput, TRow>) => ToolDef<TInput, { rows: TRow[]; }> | Model-callable tool or tool factory for mysql. |
MysqlToolOptions | type | MysqlToolOptions<TInput, TRow> | Configuration options for mysql tool. |
@fabric-harness/databases/sqlite
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
SqliteClientLike | type | SqliteClientLike | Type contract for sqlite client like. |
SqliteStatementLike | type | SqliteStatementLike | Type contract for sqlite statement like. |
sqliteTool | value | <TInput = JsonObject, TRow = JsonObject>(options: SqliteToolOptions<TInput, TRow>) => ToolDef<TInput, { rows?: TRow[]; result?: unknown; }> | Model-callable tool or tool factory for sqlite. |
SqliteToolOptions | type | SqliteToolOptions<TInput, TRow> | Configuration options for sqlite tool. |
@fabric-harness/databases/mongodb
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
MongoCollectionLike | type | MongoCollectionLike<T> | Type contract for mongo collection like. |
MongoCursorLike | type | MongoCursorLike<T> | Type contract for mongo cursor like. |
mongoFindTool | value | <TInput = JsonObject, TDocument = JsonObject>(options: MongoFindToolOptions<TInput, TDocument>) => ToolDef<TInput, { documents: TDocument[]; }> | Collection-bound find tool. Host code constructs the filter and projection. |
MongoFindToolOptions | type | MongoFindToolOptions<TInput, TDocument> | Configuration options for mongo find tool. |
@fabric-harness/databases/redis
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
RedisClientLike | type | RedisClientLike | Type contract for redis client like. |
RedisToolOptions | type | RedisToolOptions | Configuration options for redis tool. |
redisTools | value | (options: RedisToolOptions) => Array<ToolDef> | Runtime API for redis tools; the generated signature shows its accepted inputs and return type. |
@fabric-harness/databricks
@fabric-harness/databricks
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
analyticsCopilotGovernance | value | (options: AnalyticsCopilotGovernanceOptions) => AnalyticsCopilotGovernance | Governance defaults for the analytics-copilot path. Safe Genie questions and sql_read carry a read effect and remain interactive; arbitrary SQL execution and Genie lifecycle tools retain steward approval. Enabling another authoring service with this pack fails bundle initialization until the caller deliberately expands its approval scope. |
AnalyticsCopilotGovernance | type | AnalyticsCopilotGovernance | Type contract for analytics copilot governance. |
AnalyticsCopilotGovernanceOptions | type | AnalyticsCopilotGovernanceOptions | Configuration options for analytics copilot governance. |
appServicePrincipalFromEnv | value | (env?: Record<string, string | undefined>) => Extract<DatabricksPrincipal, { kind: "service-principal"; }> | undefined | The service principal a Databricks App runs as, from the standard app runtime environment (DATABRICKS_HOST / DATABRICKS_CLIENT_ID / DATABRICKS_CLIENT_SECRET). Returns undefined when any variable is missing, so callers can fall back to explicit configuration. |
buildMlflowTrace | value | (input: MlflowTraceInput) => MlflowTracePayload | Build the MLflow V3 POST /api/3.0/mlflow/traces payload for one settled submission. Pure and deterministic: trace/span ids derive from the submission id (+ span index) via SHA-256, so replaying the same settled submission produces byte-identical ids. The root span covers the whole submission; buffered TelemetrySpans become its children. |
chooseDatabricksSqlWarehouse | value | (warehouses: readonly DatabricksSqlWarehouse[]) => DatabricksSqlWarehouse | undefined | Runtime API for choose databricks sql warehouse; the generated signature shows its accepted inputs and return type. |
ConnectDatabricksManagedMcpOptions | type | ConnectDatabricksManagedMcpOptions | Configuration options for connect databricks managed mcp. |
connectDatabricksManagedMcpServer | value | (options: ConnectDatabricksManagedMcpOptions) => Promise<McpServerConnection> | Connect to one Databricks managed MCP endpoint with a rotating OBO or service token. Remote tools are classified before they can enter a governed bundle; unknown effects fail closed. |
ConsumptionGroupBy | type | ConsumptionGroupBy | Type contract for consumption group by. |
ConsumptionSummary | type | ConsumptionSummary | Type contract for consumption summary. |
ConsumptionSummaryOptions | type | ConsumptionSummaryOptions | Configuration options for consumption summary. |
createDatabricksAppUserAuthenticator | value | (options: DatabricksAppUserAuthenticatorOptions) => (request: { headers: Headers | Record<string, string | string[] | undefined>; }) => Promise<DatabricksAppAuthenticatedPrincipal | false | undefined> | Authenticate Databricks Apps forwarded user tokens and isolate each user by default. Validation calls the workspace current-user API once per token digest; raw tokens are never stored as cache keys or returned to Fabric Harness. |
createDatabricksAuthenticatedFetch | value | (options: DatabricksAuthenticatedFetchOptions) => typeof fetch | Fetch adapter for third-party SDKs that require a standard fetch surface. A fresh principal token is resolved per attempt and one auth refresh retry is bounded to 401/403. |
createDatabricksAuthoringCertificationChecks | value | (fixtures: DatabricksAuthoringCertificationFixtures) => DatabricksCertificationCheck[] | Creates databricks authoring certification checks. |
createDatabricksRagChain | value | (options: DatabricksRagChainResolvedOptions) => DatabricksRagChain | Thin orchestration of Databricks-native AI Search + Model Serving for the online RAG inference chain documented in the Databricks AI Cookbook. Prefer databricksRagChain from the package root when you have a databricks({ aiSearch }) config — it wires the bundle for you. Does not implement offline chunking/indexing (use Databricks Jobs/Lakeflow). Does not replace Mosaic Agent Evaluation — export turns with rag-eval helpers. |
databricks | value | (config: DatabricksBundleConfig) => DatabricksBundle | One-call wiring for a Databricks-native agent: model serving, a UC principal threaded through model + data + state, governed tools, an approval/egress policy, and (optionally) Lakebase-backed durable state. Also registers databricks/* model refs. Everything is layered on Unity Catalog — never a replacement for it. |
DATABRICKS_AGENT_SERVICE_SECURABLE | value | "AGENT_SERVICE" | Constant defining databricks agent service securable. |
DATABRICKS_AGENT_SERVICES_API | value | "/api/2.1/unity-catalog/agent-services" | Constant defining databricks agent services api. |
DATABRICKS_API_VERSIONS | value | { readonly sdkJs: string; readonly jobs: "2.2"; readonly sqlStatements: "2.0"; readonly unityCatalog: "2.1"; readonly workspace: "2.0"; readonly mlflow: "2.0"; readonly lakebaseCredentials: "2.0"; readonly apps: "2.0"; readonly responses: "agent/v1/responses"; readonly ai... | Constant defining databricks api versions. |
DATABRICKS_APP_USER_PERMISSIONS | value | readonly ["agent:invoke", "approval:read", "approval:write", "artifact:read", "mcp:invoke", "session:abort", "session:delete", "session:read"] | Constant defining databricks app user permissions. |
DATABRICKS_AUTH_MODES | value | readonly [{ readonly mode: "oauth-m2m"; readonly production: true; readonly use: "External services and CI service principals."; }, { readonly mode: "app-service-principal"; readonly production: true; readonly use: "Databricks Apps runtime identity."; }, &#... | Constant defining databricks auth modes. |
DATABRICKS_AUTHORING_CERTIFICATION_CHECKS | value | readonly ["approval-provenance", "jobs-authoring", "lakeflow-authoring", "ai-search-admin", "serving-admin", "uc-admin-obo-execution", "workspace-write", "secrets-write", "genie-authoring"] | Constant defining databricks authoring certification checks. |
DATABRICKS_CAPABILITIES | value | readonly DatabricksCapability[] | Public capability registry. contractClouds describes designed API portability; clouds is deliberately narrower and is derived only from retained evidence linked to that capability. |
DATABRICKS_CAPABILITY_EVIDENCE | value | readonly DatabricksCapabilityEvidenceReference[] | Constant defining databricks capability evidence. |
DATABRICKS_CERTIFICATION_RESOURCE_PREFIX | value | "fabric-harness-authoring-cert-" | Constant defining databricks certification resource prefix. |
DATABRICKS_OPTIONAL_CERTIFICATION_CHECKS | value | readonly ["agent-services", "rag-evaluation", "responses-agent", "ai-search", "genie-agent-mode", "feature-serving", "lakeflow", "jobs", "notebook", "jobs-classic-authoring", "ai-search-delta-sync-admin", "serving-provisioned-throughput-admin"] | Tier O checks are preview, SKU-specific, or not part of the default product spine. |
DATABRICKS_PACKAGE_COMPATIBILITY | value | { readonly node: ">=22.0.0"; readonly package: "@fabric-harness/databricks"; readonly packageRange: ">=7.0.0 <8"; readonly pg: "^8.11.0 (only for Lakebase)"; } | Constant defining databricks package compatibility. |
DATABRICKS_PLATFORM_DOMAINS | value | readonly DatabricksPlatformDomain[] | Whole-platform inventory. A domain remains listed even when its current Harness coverage is empty, preventing documentation and release claims from silently omitting native Databricks product families. |
DATABRICKS_RELEASE_CERTIFICATION_CHECKS | value | readonly ["identity", "ai-gateway", "sql", "unity-catalog", "uc-denial", "uc-allowed-select", "catalog-preflight-denial", "mutation-approval", "model-serving", "rag", "genie", "managed-mcp", "volumes", "lakebase", "lakebase-app-restart", "dynamic-agent", "lineage", "obo", "sys... | Tier R checks prove the supported Databricks consumption path. A release certification cannot pass when one of these checks fails or is not configured. |
DATABRICKS_SDK_VERSION | value | string | Exact modular Databricks SDK release used by every generated service client. |
databricksActualCostSource | value | (client: DatabricksStatementClient, warehouseId: string, options?: DatabricksActualCostSourceOptions) => ActualCostSource | Create a Databricks-backed ActualCostSource that queries system.billing.usage joined to system.billing.list_prices for real spend data. Results are cached per-scope-key for cacheTtlMs (default 60s) to avoid hammering the SQL warehouse. |
DatabricksActualCostSourceOptions | type | DatabricksActualCostSourceOptions | Configuration options for databricks actual cost source. |
DatabricksAgentEndpointClient | value | typeof DatabricksAgentEndpointClient | Bounded OpenResponses invocation for an existing Databricks agent endpoint. The endpoint remains owned and permissioned by Databricks; Harness only treats it as a governed read/subagent tool. |
DatabricksAgentEndpointInvocation | type | DatabricksAgentEndpointInvocation | Type contract for databricks agent endpoint invocation. |
DatabricksAgentEndpointResponse | type | DatabricksAgentEndpointResponse | Response contract for databricks agent endpoint. |
DatabricksAgentEntity | type | DatabricksAgentEntity | Type contract for databricks agent entity. |
DatabricksAgentService | type | DatabricksAgentService | Type contract for databricks agent service. |
DatabricksAgentServiceConfig | type | DatabricksAgentServiceConfig | Type contract for databricks agent service config. |
DatabricksAgentServiceConnection | type | DatabricksAgentServiceConnection | Type contract for databricks agent service connection. |
DatabricksAgentServiceCreateOptions | type | DatabricksAgentServiceCreateOptions | Configuration options for databricks agent service create. |
DatabricksAgentServiceGrantChange | type | DatabricksAgentServiceGrantChange | Type contract for databricks agent service grant change. |
DatabricksAgentServiceList | type | DatabricksAgentServiceList | Type contract for databricks agent service list. |
DatabricksAgentServicePermission | type | DatabricksAgentServicePermission | Type contract for databricks agent service permission. |
DatabricksAgentServicePermissions | type | DatabricksAgentServicePermissions | Type contract for databricks agent service permissions. |
DatabricksAgentServicePrivilege | type | DatabricksAgentServicePrivilege | Type contract for databricks agent service privilege. |
DatabricksAgentServices | value | typeof DatabricksAgentServices | Typed lifecycle client for Unity Catalog Agent Services. Databricks currently supports registration, discovery and grants only. This client intentionally has no invoke method until runtime invocation is part of the Agent Services API. |
DatabricksAgentServicesOptions | type | DatabricksAgentServicesOptions | Configuration options for databricks agent services. |
DatabricksAgentServiceUpdateOptions | type | DatabricksAgentServiceUpdateOptions | Configuration options for databricks agent service update. |
DatabricksAiGatewayUpdate | type | DatabricksAiGatewayUpdate | Type contract for databricks ai gateway update. |
DatabricksAiQueryPolicy | type | DatabricksAiQueryPolicy | Type contract for databricks ai query policy. |
databricksAiQueryTool | value | (client: DatabricksStatementClient, endpointPolicy: DatabricksAiQueryPolicy, options: DatabricksAiQueryToolOptions) => ToolDef<{ endpoint: string; request: string; }, unknown> | ai_query(endpoint, request) — run model inference inside the SQL warehouse against a serving endpoint. Drives both serving and SQL-warehouse consumption. Uses named SQL parameters, so the endpoint and request are never string-interpolated into SQL. |
DatabricksAiQueryToolOptions | type | DatabricksAiQueryToolOptions | Configuration options for databricks ai query tool. |
databricksAiSearch | value | (options: DatabricksAiSearchOptions) => DatabricksAiSearchRetriever | Databricks AI Search as a Retriever. Runs under the bundle's Unity Catalog principal. |
DatabricksAiSearchAdmin | value | typeof DatabricksAiSearchAdmin | Runtime API for databricks ai search admin; the generated signature shows its accepted inputs and return type. |
DatabricksAiSearchAdminClient | type | DatabricksAiSearchAdminClient | Client implementation for databricks ai search admin. |
DatabricksAiSearchAdminOperation | type | DatabricksAiSearchAdminOperation | One model-callable AI Search administration operation. |
DatabricksAiSearchAdminPolicy | type | DatabricksAiSearchAdminPolicy | Bounds the model-callable AI Search admin tools. allowedOperations decides which tools exist at all; the index/endpoint arms pin the resource names those tools may name. An index or endpoint dimension no registered operation uses may be omitted; omitting the embedding arm instead withholds delta-sync index creation (see DatabricksAiSearchEmbeddingArm). { allowAnyAiSearchAdmin: true } is the deliberate, greppable unbounded opt-out. |
databricksAiSearchAdminTools | value | (client: DatabricksAiSearchAdminClient, policy: DatabricksAiSearchAdminPolicy) => ToolDef[] | Model-callable AI Search administration, bounded by an explicit policy. allowedOperations filters which tools are registered at all, and every resource name is pinned into the tool's input schema and re-checked at call time before the Vector Search API is touched. The typed DatabricksAiSearchAdmin client stays unbounded. |
DatabricksAiSearchInputMode | type | DatabricksAiSearchInputMode | Type contract for databricks ai search input mode. |
DatabricksAiSearchOptions | type | DatabricksAiSearchOptions | Configuration options for databricks ai search. |
DatabricksAiSearchQueryOptions | type | DatabricksAiSearchQueryOptions | Configuration options for databricks ai search query. |
DatabricksAiSearchQueryResult | type | DatabricksAiSearchQueryResult | Result returned by databricks ai search query. |
DatabricksAiSearchRetriever | type | DatabricksAiSearchRetriever | Type contract for databricks ai search retriever. |
DatabricksAiSearchStrategy | type | DatabricksAiSearchStrategy | Type contract for databricks ai search strategy. |
databricksAnthropicGatewayBaseUrl | value | (host: string) => string | Runtime API for databricks anthropic gateway base url; the generated signature shows its accepted inputs and return type. |
DatabricksApiFidelity | type | DatabricksApiFidelity | Type contract for databricks api fidelity. |
databricksApp | value | (options?: DatabricksAppOptions) => DatabricksAppRuntime | Runtime API for databricks app; the generated signature shows its accepted inputs and return type. |
DatabricksAppAuthenticatedPrincipal | type | DatabricksAppAuthenticatedPrincipal | Type contract for databricks app authenticated principal. |
DatabricksAppOptions | type | DatabricksAppOptions | Production preset for agents hosted on Databricks Apps (v2, workstream C5). One call resolves the runtime from the standard app environment: the app's service principal (client-credentials OAuth), official workspace SDK clients and serving-endpoint model provider, Lakebase-backed persistence for sessions + submissions + conversation streams, and submission-keyed telemetry — all running as one governed identity that Unity Catalog enforces. See the package declarations for an example. |
DatabricksAppRecoveryEvidence | type | DatabricksAppRecoveryEvidence | Type contract for databricks app recovery evidence. |
DatabricksApprovalRuleOptions | type | DatabricksApprovalRuleOptions | Configuration options for databricks approval rule. |
databricksApprovalRules | value | (tools: ToolDef[], options: DatabricksApprovalRuleOptions) => ApprovalPolicyRule[] | Builds approval rules (one per gated tool) for CapabilityPolicy.toolPolicy.approvalRules. |
DatabricksAppRuntime | type | DatabricksAppRuntime | Type contract for databricks app runtime. |
DatabricksAppUserAuthenticatorOptions | type | DatabricksAppUserAuthenticatorOptions | Configuration options for databricks app user authenticator. |
DatabricksAppUserAuthorizationInspection | type | DatabricksAppUserAuthorizationInspection | Type contract for databricks app user authorization inspection. |
DatabricksAppUserIsolationEvidence | type | DatabricksAppUserIsolationEvidence | Type contract for databricks app user isolation evidence. |
DatabricksAssetBundleEntry | type | DatabricksAssetBundleEntry | One checked-in Asset Bundle as configured on databricks({ assetBundles }). |
databricksAssetBundleLifecycle | value | (options: DatabricksAssetBundleOptions) => DatabricksAssetBundleLifecycle | Runtime API for databricks asset bundle lifecycle; the generated signature shows its accepted inputs and return type. |
DatabricksAssetBundleLifecycle | value | typeof DatabricksAssetBundleLifecycle | Governed lifecycle for a checked-in Databricks Asset Bundle (DAB). Harness does not generate bundle YAML — it makes validate/deploy/run/destroy of an existing bundle a fingerprinted, approval-gated operation: - fingerprint() hashes the bundle source tree (sorted relative paths + content), excluding .databricks/ CLI state, node_modules/, and dist/. - deploy() validates, deploys, then upserts the managed-resource record. When the caller passes expectedFingerprint and a record exists with a different fingerprint, deploy fails with DatabricksManagedResourceConflictError (optimisti... |
databricksAssetBundleLifecycles | value | (options: DatabricksAssetBundleMapOptions, defaults?: Omit<DatabricksAssetBundleOptions, "bundleDir" | "instanceName">) => Map<string, DatabricksAssetBundleLifecycle> | Build one lifecycle per named bundle. Names are validated (they reach the model as tool input and the managed-resource store as ids) and sorted, so tool enums and dispatch stay deterministic. defaults are applied under each entry, letting a caller set one principalLabel for every bundle. |
DatabricksAssetBundleMapOptions | type | DatabricksAssetBundleMapOptions | Several checked-in bundles keyed by logical name; the key becomes the lifecycle's instanceName. |
DatabricksAssetBundleOptions | type | DatabricksAssetBundleOptions | Configuration options for databricks asset bundle. |
databricksAssetBundleTools | value | (options: DatabricksAssetBundleOptions | DatabricksAssetBundleLifecycle | DatabricksAssetBundleMapOptions | Map<string, DatabricksAssetBundleLifecycle>) => ToolDef[] | Model-facing tools for the governed bundle lifecycle. Write tools are approval-gated by the databricks() bundle like every other authoring surface. A single bundle keeps bundle-free tool schemas; a named map adds a required bundle selector to every schema (even with one entry, so the schema and its approval digests stay stable when a second bundle is added) and governs only the bundle the call actually names. |
DatabricksAuthenticatedFetchOptions | type | DatabricksAuthenticatedFetchOptions | Configuration options for databricks authenticated fetch. |
DatabricksAuthoringCertificationFixtures | type | DatabricksAuthoringCertificationFixtures | Type contract for databricks authoring certification fixtures. |
DatabricksAuthoringLifecycle | type | DatabricksAuthoringLifecycle<Resource, Mutation> | Type contract for databricks authoring lifecycle. |
DatabricksAuthoringLifecycleEvidence | type | DatabricksAuthoringLifecycleEvidence | Type contract for databricks authoring lifecycle evidence. |
DatabricksBundle | type | DatabricksBundle | Type contract for databricks bundle. |
DatabricksBundleConfig | type | DatabricksBundleConfig | Type contract for databricks bundle config. |
DatabricksCapability | type | DatabricksCapability | Type contract for databricks capability. |
DatabricksCapabilityEvidenceReference | type | DatabricksCapabilityEvidenceReference | Type contract for databricks capability evidence reference. |
DatabricksCapabilityStatus | type | DatabricksCapabilityStatus | Type contract for databricks capability status. |
DatabricksCertificationBlockingTier | type | DatabricksCertificationBlockingTier | Type contract for databricks certification blocking tier. |
DatabricksCertificationCheck | type | DatabricksCertificationCheck | Type contract for databricks certification check. |
DatabricksCertificationCleanupLedger | value | typeof DatabricksCertificationCleanupLedger | Reverse-order cleanup ledger for live lifecycle certification. |
DatabricksCertificationEnvironmentIssue | type | DatabricksCertificationEnvironmentIssue | Type contract for databricks certification environment issue. |
DatabricksCertificationEvidence | type | DatabricksCertificationEvidence | Type contract for databricks certification evidence. |
DatabricksCertificationLevel | type | DatabricksCertificationLevel | Type contract for databricks certification level. |
DatabricksCertificationResult | type | DatabricksCertificationResult | Result returned by databricks certification. |
DatabricksCertificationStatus | type | DatabricksCertificationStatus | Type contract for databricks certification status. |
DatabricksCertificationSweepClients | type | DatabricksCertificationSweepClients | Type contract for databricks certification sweep clients. |
DatabricksCertificationSweepOptions | type | DatabricksCertificationSweepOptions | Configuration options for databricks certification sweep. |
DatabricksCertificationSweepResult | type | DatabricksCertificationSweepResult | Result returned by databricks certification sweep. |
databricksCertificationTier | value | (checkId: string) => DatabricksCertificationTier | Return the default certification tier for a built-in check. Custom checks default to Tier O. |
DatabricksCertificationTier | type | DatabricksCertificationTier | Type contract for databricks certification tier. |
DatabricksCertificationWorkspaceSweepOptions | type | DatabricksCertificationWorkspaceSweepOptions | Configuration options for databricks certification workspace sweep. |
DatabricksCleanupResource | type | DatabricksCleanupResource | Type contract for databricks cleanup resource. |
DatabricksCloud | type | string | Type contract for databricks cloud. |
DatabricksCommandResult | type | DatabricksCommandResult | Result returned by databricks command. |
DatabricksCommandRunner | type | DatabricksCommandRunner | Type contract for databricks command runner. |
databricksCompatibilityRecord | value | (evidence: DatabricksCertificationEvidence) => DatabricksWorkspaceCompatibilityRecord | Convert successful, fully identified certification evidence into a publishable matrix row. |
DatabricksComputePolicy | type | DatabricksComputePolicy | Type contract for databricks compute policy. |
databricksConsumption | value | (client: DatabricksStatementClient, options: DatabricksConsumptionOptions) => { summary(opts: ConsumptionSummaryOptions): Promise<ConsumptionSummary>; } | System-Tables consumption reporting. Reads system.billing.usage joined to list_prices to report real DBUs + list cost — the "prove the consumption" artifact for chargeback and partner credit. |
DatabricksConsumption | type | { summary(opts: ConsumptionSummaryOptions): Promise<ConsumptionSummary>; } | Type contract for databricks consumption. |
DatabricksConsumptionOptions | type | DatabricksConsumptionOptions | Configuration options for databricks consumption. |
databricksConsumptionTool | value | (client: DatabricksStatementClient, options: DatabricksConsumptionToolOptions) => ToolDef<{ days?: number; startDate?: string; endDate?: string; groupBy?: ConsumptionGroupBy; }, unknown> | Agent-callable consumption report over the last days (default 30) or an explicit date window. |
DatabricksConsumptionToolOptions | type | DatabricksConsumptionToolOptions | Configuration options for databricks consumption tool. |
DatabricksCostReconciliationOptions | type | DatabricksCostReconciliationOptions | Configuration options for databricks cost reconciliation. |
DatabricksCostReconciliationResult | type | DatabricksCostReconciliationResult | Result returned by databricks cost reconciliation. |
DatabricksCreatedJob | type | DatabricksCreatedJob | Type contract for databricks created job. |
DatabricksCreateJobOptions | type | DatabricksCreateJobOptions | Configuration options for databricks create job. |
DatabricksCrossTierEvidenceManifest | type | DatabricksCrossTierEvidenceManifest | Type contract for databricks cross tier evidence manifest. |
DatabricksCustomModelEntity | type | DatabricksCustomModelEntity | Type contract for databricks custom model entity. |
DatabricksDbtTaskSpec | type | DatabricksDbtTaskSpec | Type contract for databricks dbt task spec. |
DatabricksDynamicAgentEvidence | type | DatabricksDynamicAgentEvidence | Type contract for databricks dynamic agent evidence. |
databricksEmbeddings | value | (options: DatabricksEmbeddingsOptions) => EmbeddingProvider | Embeddings via a Mosaic AI serving embedding endpoint. Databricks exposes the OpenAI-compatible embeddings surface at <host>/serving-endpoints/embeddings with the endpoint name as model. Reuses the bundle's generated Model Serving Query client, so it inherits the rotating UC-principal credential. (URL/response schema worth a smoke test against a live embedding endpoint — chat and embeddings share the OpenAI-compatible convention but endpoint families can differ.) |
DatabricksEmbeddingsOptions | type | DatabricksEmbeddingsOptions | Configuration options for databricks embeddings. |
DatabricksExternalModelEntity | type | DatabricksExternalModelEntity | Type contract for databricks external model entity. |
databricksFeatureLookupTool | value | (client: DatabricksModelServingQueryClient, options: DatabricksFeatureLookupToolOptions) => ToolDef<{ records: JsonObject[]; }, unknown> | Low-latency feature lookup from a Databricks Feature Serving endpoint (backed by an Online Table). The model passes primary-key records; the endpoint returns the served feature values. Drives serving consumption and keeps features governed by Unity Catalog under the bundle principal. |
DatabricksFeatureLookupToolOptions | type | DatabricksFeatureLookupToolOptions | Configuration options for databricks feature lookup tool. |
databricksFoundationModelProvider | value | (options: DatabricksModelOptions) => ModelProvider | Databricks inference provider supporting both Unity AI Gateway model services and custom Model Serving endpoints. In auto mode, fully-qualified system.ai.* models use AI Gateway and other endpoint names retain the /serving-endpoints route. |
databricksGenie | value | (client: DatabricksGenieSdkClient, options: DatabricksGenieClientOptions) => DatabricksGenieClient | Runtime API for databricks genie; the generated signature shows its accepted inputs and return type. |
DatabricksGenieAccessControl | type | DatabricksGenieAccessControl | Type contract for databricks genie access control. |
DatabricksGenieAdmin | value | typeof DatabricksGenieAdmin | Runtime API for databricks genie admin; the generated signature shows its accepted inputs and return type. |
DatabricksGenieAdminOptions | type | DatabricksGenieAdminOptions | Configuration options for databricks genie admin. |
DatabricksGenieAgent | type | DatabricksGenieAgent | Type contract for databricks genie agent. |
DatabricksGenieAgentModeClient | value | typeof DatabricksGenieAgentModeClient | Client implementation for databricks genie agent mode. |
DatabricksGenieAgentModeClientOptions | type | DatabricksGenieAgentModeClientOptions | Configuration options for databricks genie agent mode client. |
DatabricksGenieAgentModeCompletedEvent | type | DatabricksGenieAgentModeCompletedEvent | Type contract for databricks genie agent mode completed event. |
DatabricksGenieAgentModeCreatedEvent | type | DatabricksGenieAgentModeCreatedEvent | Type contract for databricks genie agent mode created event. |
DatabricksGenieAgentModeErrorInfo | type | DatabricksGenieAgentModeErrorInfo | Type contract for databricks genie agent mode error info. |
DatabricksGenieAgentModeEvent | type | DatabricksGenieAgentModeEvent | Type contract for databricks genie agent mode event. |
DatabricksGenieAgentModeFailedEvent | type | DatabricksGenieAgentModeFailedEvent | Type contract for databricks genie agent mode failed event. |
DatabricksGenieAgentModeItemPage | type | DatabricksGenieAgentModeItemPage | Type contract for databricks genie agent mode item page. |
DatabricksGenieAgentModeOutputEvent | type | DatabricksGenieAgentModeOutputEvent | Type contract for databricks genie agent mode output event. |
DatabricksGenieAgentModeProtocolError | value | typeof DatabricksGenieAgentModeProtocolError | Error raised for databricks genie agent mode protocol failures. |
DatabricksGenieAgentModeResponse | type | DatabricksGenieAgentModeResponse | Response contract for databricks genie agent mode. |
DatabricksGenieAgentModeResponseError | value | typeof DatabricksGenieAgentModeResponseError | Error raised for databricks genie agent mode response failures. |
DatabricksGenieAgentModeTimeoutError | value | typeof DatabricksGenieAgentModeTimeoutError | Error raised for databricks genie agent mode timeout failures. |
databricksGenieAgentModeTool | value | (client: DatabricksGenieAgentModeClient, agentId: string, options?: DatabricksGenieAgentModeToolOptions) => ToolDef | Model-callable tool or tool factory for databricks genie agent mode. |
DatabricksGenieAgentModeToolOptions | type | DatabricksGenieAgentModeToolOptions | Configuration options for databricks genie agent mode tool. |
DatabricksGenieAgentModeUnknownEvent | type | DatabricksGenieAgentModeUnknownEvent | Type contract for databricks genie agent mode unknown event. |
DatabricksGenieAgentPage | type | DatabricksGenieAgentPage | Type contract for databricks genie agent page. |
DatabricksGenieAgentReference | type | DatabricksGenieAgentReference | Type contract for databricks genie agent reference. |
DatabricksGenieAgentSpecV2 | type | DatabricksGenieAgentSpecV2 | Type contract for databricks genie agent spec v2. |
DatabricksGenieAgentUpdate | type | DatabricksGenieAgentUpdate | Type contract for databricks genie agent update. |
DatabricksGenieAskInput | type | DatabricksGenieAskInput | Type contract for databricks genie ask input. |
DatabricksGenieAttachment | type | DatabricksGenieAttachment | Type contract for databricks genie attachment. |
DatabricksGenieAuthoringToolOptions | type | DatabricksGenieAuthoringToolOptions | Configuration options for databricks genie authoring tool. |
DatabricksGenieBenchmark | type | DatabricksGenieBenchmark | Type contract for databricks genie benchmark. |
DatabricksGenieClient | value | typeof DatabricksGenieClient | Client implementation for databricks genie. |
DatabricksGenieClientOptions | type | DatabricksGenieClientOptions | Configuration options for databricks genie client. |
DatabricksGenieColumnSpec | type | DatabricksGenieColumnSpec | Type contract for databricks genie column spec. |
DatabricksGenieCommentPage | type | DatabricksGenieCommentPage | Type contract for databricks genie comment page. |
DatabricksGenieConfig | type | DatabricksGenieConfig | Type contract for databricks genie config. |
DatabricksGenieConversationPage | type | DatabricksGenieConversationPage | Type contract for databricks genie conversation page. |
DatabricksGenieConversationSummary | type | DatabricksGenieConversationSummary | Type contract for databricks genie conversation summary. |
DatabricksGenieDataSource | type | DatabricksGenieDataSource | Data or filesystem source for databricks genie data. |
DatabricksGenieExport | type | DatabricksGenieExport | Type contract for databricks genie export. |
DatabricksGenieJoinSide | type | DatabricksGenieJoinSide | Type contract for databricks genie join side. |
DatabricksGenieJoinSpec | type | DatabricksGenieJoinSpec | Type contract for databricks genie join spec. |
DatabricksGenieManagementConfig | type | DatabricksGenieManagementConfig | Type contract for databricks genie management config. |
DatabricksGenieMessageComment | type | DatabricksGenieMessageComment | Type contract for databricks genie message comment. |
DatabricksGenieMessageError | value | typeof DatabricksGenieMessageError | Error raised for databricks genie message failures. |
DatabricksGenieMessagePage | type | DatabricksGenieMessagePage | Type contract for databricks genie message page. |
DatabricksGenieMessageStatus | type | string | Type contract for databricks genie message status. |
DatabricksGenieMessageSummary | type | DatabricksGenieMessageSummary | Type contract for databricks genie message summary. |
DatabricksGenieOwnershipContext | type | DatabricksGenieOwnershipContext | Type contract for databricks genie ownership context. |
DatabricksGeniePermissionChange | type | DatabricksGeniePermissionChange | Type contract for databricks genie permission change. |
DatabricksGeniePermissionLevel | type | DatabricksGeniePermissionLevel | Type contract for databricks genie permission level. |
DatabricksGeniePermissions | type | DatabricksGeniePermissions | Type contract for databricks genie permissions. |
DatabricksGenieProtocolError | value | typeof DatabricksGenieProtocolError | Error raised for databricks genie protocol failures. |
DatabricksGenieQueryAttachment | type | DatabricksGenieQueryAttachment | Type contract for databricks genie query attachment. |
DatabricksGenieQueryResult | type | DatabricksGenieQueryResult | Result returned by databricks genie query. |
DatabricksGenieResponse | type | DatabricksGenieResponse | Response contract for databricks genie. |
DatabricksGenieResponseLimitError | value | typeof DatabricksGenieResponseLimitError | Error raised for databricks genie response limit failures. |
DatabricksGenieSqlExample | type | DatabricksGenieSqlExample | Type contract for databricks genie sql example. |
DatabricksGenieSqlFunction | type | DatabricksGenieSqlFunction | Type contract for databricks genie sql function. |
DatabricksGenieSqlPolicy | type | DatabricksGenieSqlPolicy | Type contract for databricks genie sql policy. |
DatabricksGenieSqlPolicyInput | type | DatabricksGenieSqlPolicyInput | Type contract for databricks genie sql policy input. |
DatabricksGenieSqlPolicyResult | type | DatabricksGenieSqlPolicyResult | Result returned by databricks genie sql policy. |
DatabricksGenieSqlSnippet | type | DatabricksGenieSqlSnippet | Type contract for databricks genie sql snippet. |
DatabricksGenieSqlSnippets | type | DatabricksGenieSqlSnippets | Type contract for databricks genie sql snippets. |
DatabricksGenieSuggestedQuestionsAttachment | type | DatabricksGenieSuggestedQuestionsAttachment | Type contract for databricks genie suggested questions attachment. |
DatabricksGenieTextAttachment | type | DatabricksGenieTextAttachment | Type contract for databricks genie text attachment. |
DatabricksGenieTimeoutError | value | typeof DatabricksGenieTimeoutError | Error raised for databricks genie timeout failures. |
databricksGenieTool | value | (client: DatabricksGenieSdkClient, options: DatabricksGenieToolOptions) => ToolDef<{ question: string; conversationId?: string; }, DatabricksGenieResponse> | Genie Agents — delegate a natural-language analytics question to a governed Genie Agent. Genie generates and runs SQL on the warehouse and returns typed answer, query, result, and visualization attachments. Pass conversationId to continue a multi-turn thread. |
DatabricksGenieToolOptions | type | DatabricksGenieToolOptions | Configuration options for databricks genie tool. |
DatabricksGenieUnknownAttachment | type | DatabricksGenieUnknownAttachment | Type contract for databricks genie unknown attachment. |
DatabricksGenieVisualizationAttachment | type | DatabricksGenieVisualizationAttachment | Type contract for databricks genie visualization attachment. |
DatabricksGovernanceMetadata | type | DatabricksGovernanceMetadata | Type contract for databricks governance metadata. |
DatabricksGovernanceOptions | type | DatabricksGovernanceOptions | Configuration options for databricks governance. |
databricksGovernancePolicy | value | (options: DatabricksGovernancePolicyOptions) => CapabilityPolicy | Assembles a CapabilityPolicy for a Databricks tool set: approval routing for sensitive operations (if stewardAudience is set) plus an egress allowlist pinned to the workspace host(s). Used by the databricks() bundle; can also be merged into an agent's own policy. |
DatabricksGovernancePolicyOptions | type | DatabricksGovernancePolicyOptions | Configuration options for databricks governance policy. |
DatabricksGovernanceResourceDescriptor | type | DatabricksGovernanceResourceDescriptor | Type contract for databricks governance resource descriptor. |
DatabricksGovernedResource | type | DatabricksGovernedResource | Type contract for databricks governed resource. |
databricksHostFromCliProfile | value | (profile?: string) => Promise<string> | Workspace host resolved from a Databricks CLI profile (~/.databrickscfg or DATABRICKS_CONFIG_FILE), normalized to the workspace origin. DATABRICKS_* environment variables overlay the file per the official SDK credential chain. |
databricksIdentity | value | (principal: DatabricksPrincipal) => DatabricksTokenProvider | Builds a rotating bearer-token provider from the same native credential used by SDK clients. |
DatabricksInferenceMode | type | DatabricksInferenceMode | Type contract for databricks inference mode. |
DatabricksJobField | type | DatabricksJobField | Type contract for databricks job field. |
DatabricksJobRunPolicy | type | DatabricksJobRunPolicy | Bound for triggering existing jobs. Ids, not names: the narrow run client cannot resolve names, and call-time resolution would be a TOCTOU hole. allowAnyJobId is the explicit opt-out. |
databricksJobs | value | (client: DatabricksJobsClient, options?: DatabricksJobsOptions) => DatabricksJobs | Runtime API for databricks jobs; the generated signature shows its accepted inputs and return type. |
DatabricksJobs | value | typeof DatabricksJobs | Runtime API for databricks jobs; the generated signature shows its accepted inputs and return type. |
databricksJobsAuthoring | value | (client: DatabricksJobsAuthoringClient, computePolicy?: DatabricksComputePolicy) => DatabricksJobsAuthoring | Runtime API for databricks jobs authoring; the generated signature shows its accepted inputs and return type. |
DatabricksJobsAuthoring | value | typeof DatabricksJobsAuthoring | Runtime API for databricks jobs authoring; the generated signature shows its accepted inputs and return type. |
databricksJobsAuthoringTools | value | (client: DatabricksJobsAuthoringClient, computePolicy?: DatabricksComputePolicy, options?: { oneOffCompute?: boolean; }) => ToolDef[] | Runtime API for databricks jobs authoring tools; the generated signature shows its accepted inputs and return type. |
DatabricksJobSchedule | type | DatabricksJobSchedule | Type contract for databricks job schedule. |
DatabricksJobsClient | type | DatabricksJobsClient | Client implementation for databricks jobs. |
DatabricksJobsOptions | type | DatabricksJobsOptions | Configuration options for databricks jobs. |
DatabricksJobSpec | type | DatabricksJobSpec | Type contract for databricks job spec. |
DatabricksJobsWaitOptions | type | DatabricksJobsWaitOptions | Configuration options for databricks jobs wait. |
DatabricksJobTask | type | DatabricksJobTask | Type contract for databricks job task. |
DatabricksJobUpdate | type | DatabricksJobUpdate | Type contract for databricks job update. |
DatabricksLakeflowAuthoring | value | typeof DatabricksLakeflowAuthoring | Runtime API for databricks lakeflow authoring; the generated signature shows its accepted inputs and return type. |
databricksLakeflowAuthoringTools | value | (client: DatabricksPipelinesAuthoringClient, options?: { warehouseId?: string; statements?: DatabricksStatementClient; }) => ToolDef[] | Runtime API for databricks lakeflow authoring tools; the generated signature shows its accepted inputs and return type. |
databricksLakeflowTools | value | (client: DatabricksPipelinesClient, runPolicy?: DatabricksPipelineRunPolicy) => ToolDef[] | The default Lakeflow tool set. Omitting runPolicy is intentionally read-only. |
DatabricksLifecycleOperation | type | DatabricksLifecycleOperation | Type contract for databricks lifecycle operation. |
DatabricksLineageEvidenceRow | type | DatabricksLineageEvidenceRow | Type contract for databricks lineage evidence row. |
DatabricksLineageRecord | type | DatabricksLineageRecord | Governance for Databricks tools is layered on top of Unity Catalog, never a replacement. UC enforces table/row/column ACLs natively via the acting principal (see identity.ts). These helpers add the things UC doesn't: an audit/lineage stamp on every tool call, approval routing for sensitive operations, and an egress allowlist pinned to the workspace — all expressed through the SDK's existing CapabilityPolicy, so the loop enforces them without a bespoke engine. |
DatabricksManagedAgentKind | type | DatabricksManagedAgentKind | Type contract for databricks managed agent kind. |
databricksManagedAgentTool | value | (client: DatabricksAgentEndpointClient, options: DatabricksManagedAgentToolOptions) => ToolDef<{ question: string; previousResponseId?: string; }, DatabricksManagedAgentToolResult> | Project an existing Supervisor Agent, Knowledge Assistant, or Responses-compatible endpoint. |
DatabricksManagedAgentToolOptions | type | DatabricksManagedAgentToolOptions | Configuration options for databricks managed agent tool. |
DatabricksManagedAgentToolResult | type | DatabricksManagedAgentToolResult | Result returned by databricks managed agent tool. |
DatabricksManagedMcpBundle | type | DatabricksManagedMcpBundle | Type contract for databricks managed mcp bundle. |
DatabricksManagedMcpEndpoint | type | DatabricksManagedMcpEndpoint | Type contract for databricks managed mcp endpoint. |
DatabricksManagedMcpServerConfig | type | DatabricksManagedMcpServerConfig | Type contract for databricks managed mcp server config. |
databricksManagedMcpUrl | value | (host: string, endpoint: DatabricksManagedMcpEndpoint) => URL | Build a workspace-local managed MCP or Unity AI Gateway MCP Service endpoint. |
databricksManagedMemory | value | (client: DatabricksRawProtocolClient, options: DatabricksManagedMemoryOptions) => DatabricksManagedMemoryClient | Runtime API for databricks managed memory; the generated signature shows its accepted inputs and return type. |
DatabricksManagedMemoryClient | value | typeof DatabricksManagedMemoryClient | Explicit managed long-term memory client. Scope is required on every entry operation and is never inferred from model input, keeping tenant partitioning at the trusted application boundary. |
DatabricksManagedMemoryOptions | type | DatabricksManagedMemoryOptions | Configuration options for databricks managed memory. |
DatabricksManagedResourceConflictError | value | typeof DatabricksManagedResourceConflictError | Error raised for databricks managed resource conflict failures. |
DatabricksManagedResourceRecord | type | DatabricksManagedResourceRecord | Type contract for databricks managed resource record. |
DatabricksManagedResourceStore | type | DatabricksManagedResourceStore | Storage contract for databricks managed resource. |
DatabricksMemoryEntry | type | DatabricksMemoryEntry | Type contract for databricks memory entry. |
DatabricksMemoryEntryEdit | type | DatabricksMemoryEntryEdit | Type contract for databricks memory entry edit. |
DatabricksMemoryEntryPage | type | DatabricksMemoryEntryPage | Type contract for databricks memory entry page. |
DatabricksMemoryStore | type | DatabricksMemoryStore | Storage contract for databricks memory. |
DatabricksMemoryStorePage | type | DatabricksMemoryStorePage | Type contract for databricks memory store page. |
databricksMlflowLogMetricTool | value | (client: DatabricksExperimentsClient, runPolicy: DatabricksMlflowRunPolicy, options?: { name?: string; description?: string; }) => ToolDef<{ runId: string; key: string; value: number; step?: number; timestamp?: number; }, unknown> | Model-callable tool or tool factory for databricks mlflow log metric. |
databricksMlflowLogParamTool | value | (client: DatabricksExperimentsClient, runPolicy: DatabricksMlflowRunPolicy, options?: { name?: string; description?: string; }) => ToolDef<{ runId: string; key: string; value: string; }, unknown> | Model-callable tool or tool factory for databricks mlflow log param. |
DatabricksMlflowRunPolicy | type | DatabricksMlflowRunPolicy | Type contract for databricks mlflow run policy. |
databricksModelBaseUrl | value | (host: string, mode: Exclude<DatabricksInferenceMode, "auto">) => string | Build the OpenAI-compatible base URL used for one Databricks inference mode. |
DatabricksModelOptions | type | DatabricksModelOptions | Configuration options for databricks model. |
DatabricksModelProviderService | type | DatabricksModelProviderService | Type contract for databricks model provider service. |
databricksModelProviderSupportsAnthropic | value | (service: DatabricksModelProviderService) => boolean | Runtime API for databricks model provider supports anthropic; the generated signature shows its accepted inputs and return type. |
DatabricksModelService | type | DatabricksModelService | Type contract for databricks model service. |
DatabricksModelServiceDiscoveryOptions | type | DatabricksModelServiceDiscoveryOptions | Configuration options for databricks model service discovery. |
DatabricksNewClusterSpec | type | DatabricksNewClusterSpec | Type contract for databricks new cluster spec. |
DatabricksNotebookImport | type | DatabricksNotebookImport | Type contract for databricks notebook import. |
DatabricksNotebookRunPolicy | type | DatabricksNotebookRunPolicy | Bound for one-off notebook submission. allowAnyNotebookPath is the explicit opt-out. |
DatabricksNotebookTaskSpec | type | DatabricksNotebookTaskSpec | Type contract for databricks notebook task spec. |
databricksNotebookTool | value | (client: DatabricksJobsClient, notebookPolicy: DatabricksNotebookRunPolicy, options?: { name?: string; description?: string; existingClusterId?: string; }) => ToolDef<{ notebookPath: string; idempotencyToken?: string; baseParameters?: JsonObject; runName?:... | Submit a one-off Databricks notebook run. notebookPolicy is required for the same reason the run-job tool requires one, and more strongly: an unbounded notebook path executes arbitrary workspace code as the calling principal. |
DatabricksPermissionChange | type | DatabricksPermissionChange | Type contract for databricks permission change. |
databricksPersistence | value | (options: DatabricksPersistenceOptions) => DatabricksPersistence | One-call Lakebase persistence for Databricks-hosted agents. See the package declarations for an example. The Postgres store implementations come from @fabric-harness/node (optional peer) and run unchanged against Lakebase — the only Databricks specifics are database-credential exchange, refresh caching, and TLS defaults from lakebaseClient. |
DatabricksPersistence | type | DatabricksPersistence | Everything the v2 runtime persists, on Lakebase, in one adapter: sessions (canonical conversation state), durable agent submissions (admission/FIFO/leases/settlement), and offset-addressable conversation streams. Implements the SDK PersistenceAdapter contract, so it plugs straight into init({ persistence }); the extra connect* methods feed startDevServer({ submissionStore, conversationStreamStore }). |
DatabricksPersistenceOptions | type | DatabricksPersistenceOptions | Configuration options for databricks persistence. |
DatabricksPersistenceStoreModule | type | DatabricksPersistenceStoreModule | The slice of @fabric-harness/node this adapter assembles. Loaded dynamically (node is an optional peer — Databricks Apps always run on Node, but this package stays importable without it); injectable for tests. |
DatabricksPipelineLibrary | type | DatabricksPipelineLibrary | Type contract for databricks pipeline library. |
databricksPipelineListTool | value | (client: DatabricksPipelinesClient, options?: ToolMeta) => ToolDef<{ maxResults?: number; filter?: string; }, unknown> | Lakeflow Declarative Pipelines (formerly DLT). These drive heavy continuous-compute consumption. start/stop mutate pipeline state (effect: 'execute', governable); list/status are reads. |
DatabricksPipelineRunPolicy | type | DatabricksPipelineRunPolicy | Type contract for databricks pipeline run policy. |
DatabricksPipelinesClient | type | DatabricksPipelinesClient | Client implementation for databricks pipelines. |
DatabricksPipelineSpec | type | DatabricksPipelineSpec | Type contract for databricks pipeline spec. |
databricksPipelineStartTool | value | (client: DatabricksPipelinesClient, runPolicy: DatabricksPipelineRunPolicy, options?: ToolMeta) => ToolDef<{ pipelineId: string; fullRefresh?: boolean; }, unknown> | Model-callable tool or tool factory for databricks pipeline start. |
databricksPipelineStatusTool | value | (client: DatabricksPipelinesClient, options?: ToolMeta) => ToolDef<{ pipelineId: string; }, unknown> | Model-callable tool or tool factory for databricks pipeline status. |
databricksPipelineStopTool | value | (client: DatabricksPipelinesClient, runPolicy: DatabricksPipelineRunPolicy, options?: ToolMeta) => ToolDef<{ pipelineId: string; }, unknown> | Model-callable tool or tool factory for databricks pipeline stop. |
DatabricksPlatformDomain | type | DatabricksPlatformDomain | Type contract for databricks platform domain. |
DatabricksPlatformDomainId | type | DatabricksPlatformDomainId | Type contract for databricks platform domain id. |
DatabricksPrincipal | type | DatabricksPrincipal | Type contract for databricks principal. |
DatabricksPrincipalEnvOptions | type | DatabricksPrincipalEnvOptions | Configuration options for databricks principal env. |
databricksPrincipalFromEnv | value | (env?: Record<string, string | undefined>, options?: DatabricksPrincipalEnvOptions) => Extract<DatabricksPrincipal, { kind: "pat" | "service-principal" | "cli-profile"; }> | Resolve a PAT or OAuth M2M principal consistently across CLIs, recipes, Apps, and tests. |
DatabricksProvisionedThroughputEntity | type | DatabricksProvisionedThroughputEntity | Type contract for databricks provisioned throughput entity. |
DatabricksPythonWheelTaskSpec | type | DatabricksPythonWheelTaskSpec | Type contract for databricks python wheel task spec. |
databricksRagChain | value | (options: DatabricksRagChainOptions) => import("./rag-chain.js").DatabricksRagChain | Cookbook-style online RAG chain over native Databricks AI Search + Model Serving. See the package declarations for an example. |
DatabricksRagChain | type | DatabricksRagChain | Type contract for databricks rag chain. |
DatabricksRagChainOptions | type | DatabricksRagChainOptions | Configuration options for databricks rag chain. |
DatabricksRagChainResolvedOptions | type | DatabricksRagChainResolvedOptions | Inputs once a bundle (or explicit retriever + model) is resolved. |
DatabricksRagInput | type | DatabricksRagInput | Type contract for databricks rag input. |
DatabricksRagRetrievalOptions | type | DatabricksRagRetrievalOptions | Configuration options for databricks rag retrieval. |
DatabricksReleaseEvidenceValidation | type | DatabricksReleaseEvidenceValidation | Type contract for databricks release evidence validation. |
DatabricksRequestTags | type | DatabricksRequestTags | Type contract for databricks request tags. |
databricksResourceFingerprint | value | (value: unknown) => Promise<string> | Runtime API for databricks resource fingerprint; the generated signature shows its accepted inputs and return type. |
DatabricksResourceNotAllowedError | value | typeof DatabricksResourceNotAllowedError | Error raised for databricks resource not allowed failures. |
DatabricksResponsesContent | type | DatabricksResponsesContent | Type contract for databricks responses content. |
DatabricksResponsesOutputItem | type | DatabricksResponsesOutputItem | Type contract for databricks responses output item. |
databricksResponsesText | value | (response: DatabricksAgentEndpointResponse) => string | Runtime API for databricks responses text; the generated signature shows its accepted inputs and return type. |
DatabricksRollingEvidenceReport | type | DatabricksRollingEvidenceReport | Type contract for databricks rolling evidence report. |
databricksRunJobTool | value | (client: DatabricksJobsClient, runPolicy: DatabricksJobRunPolicy, options?: { name?: string; description?: string; }) => ToolDef<{ jobId: number; idempotencyToken?: string; notebookParams?: JsonObject; pythonParams?: string[]; jarParams?: string[]; },... | Trigger an existing Databricks job. runPolicy is required: the run target is model-supplied, so the bound is part of constructing the tool rather than an option a caller can forget. The pinned schema is a model-facing hint; databricksJobs() re-checks the id before calling the Jobs API. |
DatabricksRunLifeCycleState | type | string | Type contract for databricks run life cycle state. |
DatabricksRunNotAllowedError | value | typeof DatabricksRunNotAllowedError | Raised before the Jobs API is called when a run target falls outside the configured bound. |
DatabricksRunOutput | type | DatabricksRunOutput | Type contract for databricks run output. |
DatabricksRunReceipt | type | DatabricksRunReceipt | Type contract for databricks run receipt. |
DatabricksRunResultState | type | string | Type contract for databricks run result state. |
DatabricksRunState | type | DatabricksRunState | Type contract for databricks run state. |
DatabricksRunTimeoutError | value | typeof DatabricksRunTimeoutError | Error raised for databricks run timeout failures. |
databricksSdk | value | (options: DatabricksSdkOptions) => DatabricksSdkClients | Build the official modular Databricks SDK clients under one governed identity. SDK-gap protocols remain private to Fabric's explicit raw protocol adapters. |
DatabricksSdkClients | type | DatabricksSdkClients | Generated Databricks service clients exposed to application code. |
DatabricksSdkOptions | type | DatabricksSdkOptions | Configuration options for databricks sdk. |
DatabricksSearchIndexSpec | type | DatabricksSearchIndexSpec | Type contract for databricks search index spec. |
DatabricksSecretsAuthoring | value | typeof DatabricksSecretsAuthoring | Runtime API for databricks secrets authoring; the generated signature shows its accepted inputs and return type. |
databricksSecretsAuthoringTools | value | (client: DatabricksSecretsClient, provider: SecretProvider) => ToolDef[] | Runtime API for databricks secrets authoring tools; the generated signature shows its accepted inputs and return type. |
databricksSecretsProvider | value | (options: DatabricksSecretsProviderOptions) => SecretProvider | Databricks Secret Management adapter. Secret values are decoded only at runtime. |
DatabricksSecretsProviderOptions | type | DatabricksSecretsProviderOptions | Configuration options for databricks secrets provider. |
DatabricksSecurableType | type | DatabricksSecurableType | Type contract for databricks securable type. |
DatabricksServingAdmin | value | typeof DatabricksServingAdmin | Runtime API for databricks serving admin; the generated signature shows its accepted inputs and return type. |
databricksServingAdminTools | value | (client: DatabricksServingAdminClient) => ToolDef[] | Runtime API for databricks serving admin tools; the generated signature shows its accepted inputs and return type. |
DatabricksServingEndpointSpec | type | DatabricksServingEndpointSpec | Type contract for databricks serving endpoint spec. |
DatabricksSparkJarTaskSpec | type | DatabricksSparkJarTaskSpec | Type contract for databricks spark jar task spec. |
DatabricksSqlClient | type | DatabricksSqlClient | Client implementation for databricks sql. |
DatabricksSqlExecutionPolicy | type | DatabricksSqlExecutionPolicy | Type contract for databricks sql execution policy. |
databricksSqlReadTool | value | (client: DatabricksSqlClient, options: DatabricksSqlReadToolOptions) => ToolDef<{ statement: string; catalog?: string; schema?: string; }, unknown> | Run one read-only query on a Databricks SQL Warehouse. The tool accepts SELECT (including SELECT-ending CTEs), rejects mutation/administration keywords, and denies multiple statements before resolving credentials or calling Statement Execution. |
DatabricksSqlReadToolOptions | type | DatabricksSqlToolOptions | Configuration options for databricks sql read tool. |
databricksSqlSandbox | value | (options: DatabricksSqlSandboxOptions) => SandboxEnv | Sandbox adapter for databricks sql. |
DatabricksSqlSandboxOptions | type | DatabricksSqlSandboxOptions | Sandbox backend that maps exec(command) to a Databricks SQL Statement Execution API call against a SQL Warehouse. Useful for data agents whose "shell" is a query interface. Behavior: - exec(sql) runs the SQL synchronously (with a timeout) and returns the serialized result set as stdout (newline-delimited JSON rows by default, or CSV when resultFormat: 'csv'). - File operations are intentionally minimal: the sandbox-virtual filesystem keeps a small in-memory map. SQL warehouses are not file servers; mount actual data via databricksVolumeSource from @fabric-harness/connectors. Usa... |
DatabricksSqlSandboxRefData | type | DatabricksSqlSandboxRefData | Type contract for databricks sql sandbox ref data. |
DatabricksSqlSandboxRegistrationOptions | type | DatabricksSqlSandboxRegistrationOptions | Configuration options for databricks sql sandbox registration. |
DatabricksSqlStatementInput | type | DatabricksSqlStatementInput | Type contract for databricks sql statement input. |
DatabricksSqlTaskSpec | type | DatabricksSqlTaskSpec | Type contract for databricks sql task spec. |
databricksSqlTool | value | (client: DatabricksSqlClient, policy: DatabricksSqlExecutionPolicy, options: DatabricksSqlToolOptions) => ToolDef<DatabricksSqlStatementInput, unknown> | Model-callable tool or tool factory for databricks sql. |
DatabricksSqlToolOptions | type | DatabricksSqlToolOptions | Configuration options for databricks sql tool. |
DatabricksSqlWarehouse | type | DatabricksSqlWarehouse | Type contract for databricks sql warehouse. |
DatabricksStatementClient | type | DatabricksStatementClient | Client implementation for databricks statement. |
DatabricksSupervisorAgentListOptions | type | DatabricksSupervisorAgentListOptions | Configuration options for databricks supervisor agent list. |
databricksSupervisorAgents | value | (sdk: SupervisorAgentsClient, endpoints: DatabricksAgentEndpointClient, options: DatabricksSupervisorAgentsOptions) => DatabricksSupervisorAgents | Runtime API for databricks supervisor agents; the generated signature shows its accepted inputs and return type. |
DatabricksSupervisorAgents | value | typeof DatabricksSupervisorAgents | Guarded composition boundary over the official generated Supervisor Agents SDK. |
DatabricksSupervisorAgentsOptions | type | DatabricksSupervisorAgentsOptions | Configuration options for databricks supervisor agents. |
DatabricksSupportTier | type | DatabricksSupportTier | Type contract for databricks support tier. |
databricksTableInfoTool | value | (client: DatabricksTablesClient, options?: { name?: string; description?: string; }) => ToolDef<{ fullName: string; }, unknown> | Model-callable tool or tool factory for databricks table info. |
databricksTelemetry | value | (options: DatabricksTelemetryOptions) => DatabricksTelemetry | Runtime API for databricks telemetry; the generated signature shows its accepted inputs and return type. |
DatabricksTelemetry | type | DatabricksTelemetry | Type contract for databricks telemetry. |
DatabricksTelemetryOptions | type | DatabricksTelemetryOptions | Cost + lineage as core telemetry (v2, workstream C4): submission lifecycle events and governed tool-call lineage land in Lakebase tables keyed by the same submissionId that drives events, settlement, and audit — so spend, lineage, and outcomes join on one stable key. Writes are fire-and-forget: a telemetry failure must never affect execution. |
databricksTenantCostLimit | value | (client: DatabricksStatementClient, warehouseId: string, tenantId: string, options: { perHourUsd?: number; perDayUsd?: number; perMonthUsd?: number; cacheTtlMs?: number; onExceed?: "throw" | "approve"; }) => CostLimit | Runtime API for databricks tenant cost limit; the generated signature shows its accepted inputs and return type. |
DatabricksTokenProvider | type | DatabricksTokenProvider | A bearer-token resolver awaited per request. Fabric uses the same native-SDK credential across generated service clients, model calls, preview streaming, and Lakebase credential exchange. |
DatabricksUnityCatalogAdmin | value | typeof DatabricksUnityCatalogAdmin | Runtime API for databricks unity catalog admin; the generated signature shows its accepted inputs and return type. |
databricksUnityCatalogAdminTools | value | (client: DatabricksUnityCatalogAdminClients, options?: { destructive?: boolean; }) => ToolDef[] | Runtime API for databricks unity catalog admin tools; the generated signature shows its accepted inputs and return type. |
DatabricksUnmanagedResourceError | value | typeof DatabricksUnmanagedResourceError | Error raised for databricks unmanaged resource failures. |
DatabricksUpstreamMaturity | type | DatabricksUpstreamMaturity | Type contract for databricks upstream maturity. |
databricksWithManagedMcp | value | (config: DatabricksBundleConfig, scope?: { tokenProvider: DatabricksTokenProvider; principal: FabricPrincipal; }) => Promise<DatabricksManagedMcpBundle> | Build a Databricks bundle after discovering and classifying managed MCP tools. |
databricksWorkspaceApi | value | (options: DatabricksWorkspaceApiOptions) => DatabricksWorkspaceApi | Runtime API for databricks workspace api; the generated signature shows its accepted inputs and return type. |
DatabricksWorkspaceApi | type | DatabricksWorkspaceApi | Credential-safe native Databricks REST escape hatch. Prefer the generated clients from databricksSdk when one exists. This client preserves access to newly released or uncommon Databricks APIs without waiting for a Harness wrapper. It is deliberately not a model tool: applications must validate requests and place governed mutations behind their own explicit tool/action boundary. |
DatabricksWorkspaceApiMethod | type | DatabricksWorkspaceApiMethod | Type contract for databricks workspace api method. |
DatabricksWorkspaceApiOptions | type | DatabricksWorkspaceApiOptions | Configuration options for databricks workspace api. |
DatabricksWorkspaceApiRequestOptions | type | DatabricksWorkspaceApiRequestOptions | Configuration options for databricks workspace api request. |
DatabricksWorkspaceCompatibilityRecord | type | DatabricksWorkspaceCompatibilityRecord | Type contract for databricks workspace compatibility record. |
databricksWorkspaceOrigin | value | (host: string) => string | Normalize a workspace hostname or URL to its HTTPS origin. |
DatabricksWorkspaceSourceOptions | type | DatabricksWorkspaceSourceOptions | Configuration options for databricks workspace source. |
defaultDatabricksCertificationChecks | value | (options?: { agentServices?: boolean; authoring?: boolean; }) => string[] | Required checks used by the protected Databricks certification workflow. |
defineDatabricksAgent | value | <TInput = JsonObject, TOutput = unknown>(options?: DefineDatabricksAgentOptions<TInput, TOutput>) => DefinedAgent<TInput, TOutput> | Defines databricks agent. |
DefineDatabricksAgentOptions | type | DefineDatabricksAgentOptions<TInput, TOutput> | Configuration options for define databricks agent. |
deployDatabricksAppArtifact | value | (options: DeployDatabricksAppArtifactOptions) => Promise<DeployDatabricksAppArtifactResult> | Deploy an already-built Fabric Harness Databricks App artifact. This is the programmatic counterpart of fh deploy --target databricks-app. It intentionally does not rebuild the artifact: release orchestrators can verify the immutable digest first, then use this function for the Databricks side effect. |
DeployDatabricksAppArtifactOptions | type | DeployDatabricksAppArtifactOptions | Configuration options for deploy databricks app artifact. |
DeployDatabricksAppArtifactResult | type | DeployDatabricksAppArtifactResult | Result returned by deploy databricks app artifact. |
destroyDatabricksAppArtifact | value | (options: DestroyDatabricksAppArtifactOptions) => Promise<DestroyDatabricksAppArtifactResult> | Destroy only resources declared by an already-built Databricks App bundle. |
DestroyDatabricksAppArtifactOptions | type | DestroyDatabricksAppArtifactOptions | Configuration options for destroy databricks app artifact. |
DestroyDatabricksAppArtifactResult | type | DestroyDatabricksAppArtifactResult | Result returned by destroy databricks app artifact. |
digestDatabricksArtifact | value | (target: string) => Promise<string> | Digest a release artifact using the standard SHA-256 file digest. Directory targets use a deterministic, tagged tree digest so deployment bundles can be certified without archiving them. |
ensureDatabricksTelemetryTables | value | (client: LakebaseClient) => Promise<void> | Create the telemetry tables when absent. Idempotent. |
exportAgentEvaluationJsonl | value | (records: LegacyAgentEvaluationRecord[]) => string | Serialize evaluation records as JSONL for MLflow / Agent Evaluation import. |
exportMlflow3EvaluationJsonl | value | (records: Mlflow3RagEvaluationRecord[]) => string | Serialize structured MLflow 3 evaluation rows as newline-delimited JSON. |
extractDatabricksGovernedResources | value | (tool: ToolDef, input: unknown) => DatabricksGovernedResource[] | Runtime API for extract databricks governed resources; the generated signature shows its accepted inputs and return type. |
fabricPrincipalFor | value | (principal: DatabricksPrincipal, overrides?: FabricPrincipalOverrides) => FabricPrincipal | Map a Databricks principal onto the SDK's FabricPrincipal so the governed identity rides submissions → tool calls → lineage/cost records. Never carries a token — ids and labels only. |
FabricPrincipalOverrides | type | FabricPrincipalOverrides | Type contract for fabric principal overrides. |
getDatabricksCapability | value | (id: string) => DatabricksCapability | undefined | Returns databricks capability. |
governanceMetadata | value | (tool: ToolDef) => DatabricksGovernanceMetadata | undefined | Runtime API for governance metadata; the generated signature shows its accepted inputs and return type. |
inferenceTableUsageQuery | value | (options: InferenceTableUsageQueryOptions) => string | SQL aggregating a serving endpoint's inference/payload table by client_request_id — one row per submission with the request count and the first/last request timestamps — for offline joins against fh_submission_telemetry.submission_id. Join contract: callers MUST send the submission id as the serving request's client_request_id (e.g. the client_request_id field on the serving-endpoint invocation) — the inference table records it verbatim, and this query's submission_id column only joins when that convention holds. Rows without a client_request_id (traffic from other callers) are... |
InferenceTableUsageQueryOptions | type | InferenceTableUsageQueryOptions | Configuration options for inference table usage query. |
inspectDatabricksAppUserAuthorization | value | (options: { headers: Headers | Record<string, string | string[] | undefined>; host: string; fetchImpl?: typeof fetch; now?: () => number; }) => Promise<DatabricksAppUserAuthorizationInspection> | Validate a Databricks Apps forwarded user token and return non-secret identity/lifetime metadata suitable for OBO lifecycle certification. The access token is never returned or included in an error. |
isDatabricksModelService | value | (model: string | undefined) => boolean | True for Unity Catalog model-service identifiers accepted by Unity AI Gateway. |
lakebaseClient | value | (options: LakebaseClientOptions) => LakebaseClient | Client implementation for lakebase. |
LakebaseClient | type | LakebaseClient | Client implementation for lakebase. |
LakebaseClientOptions | type | LakebaseClientOptions | Configuration options for lakebase client. |
lakebaseCredentialProvider | value | (options: LakebaseCredentialProviderOptions) => () => Promise<string> | Exchange a workspace OAuth token for a Lakebase database credential. The result is cached, refreshed early with jitter, and refreshes are single-flight. |
LakebaseCredentialProviderOptions | type | LakebaseCredentialProviderOptions | Configuration options for lakebase credential provider. |
LakebaseDatabricksManagedResourceStore | value | typeof LakebaseDatabricksManagedResourceStore | Durable managed-resource manifest backed by Lakebase or ordinary PostgreSQL. |
LakebaseDatabricksManagedResourceStoreOptions | type | LakebaseDatabricksManagedResourceStoreOptions | Configuration options for lakebase databricks managed resource store. |
LakebasePoolConfig | type | LakebasePoolConfig | Type contract for lakebase pool config. |
LakebasePoolFactory | type | LakebasePoolFactory | Factory for lakebase pool. |
LegacyAgentEvaluationRecord | type | LegacyAgentEvaluationRecord | One row in the shape commonly used with Databricks / MLflow GenAI evaluation tables (request / response / retrieved_context). This is an export for Mosaic Agent Evaluation and notebooks — not a reimplementation of judges. |
listDatabricksCapabilities | value | (options?: { status?: DatabricksCapabilityStatus; tier?: DatabricksSupportTier; apiFidelity?: DatabricksApiFidelity; domain?: DatabricksPlatformDomainId; }) => DatabricksCapability[] | Lists databricks capabilities. |
MemoryDatabricksManagedResourceStore | value | typeof MemoryDatabricksManagedResourceStore | In-process store for tests and single-process development. Production callers should inject persistence. |
missingDatabricksCapabilityEvidence | value | (capability: DatabricksCapability, evidence?: readonly DatabricksCapabilityEvidenceReference[]) => string[] | Runtime API for missing databricks capability evidence; the generated signature shows its accepted inputs and return type. |
Mlflow3RagEvaluationRecord | type | Mlflow3RagEvaluationRecord | MLflow 3 evaluation-dataset row with structured inputs, outputs, and expectations. |
MlflowTraceExporter | type | MlflowTraceExporter | Type contract for mlflow trace exporter. |
MlflowTraceInput | type | MlflowTraceInput | Type contract for mlflow trace input. |
MlflowTracePayload | type | MlflowTracePayload | Type contract for mlflow trace payload. |
MockDatabricksModelProvider | value | typeof MockDatabricksModelProvider | A deterministic ModelProvider for Databricks agent tests and init templates. Returns structured responses for SQL/table-info tool calls without requiring real Databricks credentials. |
MockDatabricksModelProviderOptions | type | MockDatabricksModelProviderOptions | Configuration options for mock databricks model provider. |
normalizeDatabricksGenieAgentSpec | value | (spec: DatabricksGenieAgentSpecV2) => Promise<DatabricksGenieAgentSpecV2> | Runtime API for normalize databricks genie agent spec; the generated signature shows its accepted inputs and return type. |
onBehalfOfFromHeaders | value | (headers: Headers | Record<string, string | string[] | undefined>) => Extract<DatabricksPrincipal, { kind: "on-behalf-of"; }> | undefined | On-behalf-of principal from Databricks Apps user-authorization headers: the platform forwards the signed-in user's access token as x-forwarded-access-token (plus x-forwarded-email/x-forwarded-user). Returns undefined when the request carries no user token (e.g. app service-to-service traffic) so callers fall back to the app principal. |
parseStatementRows | value | (response: unknown) => JsonObject[] | Map a statement response's columns + rows into objects keyed by column name. |
queryDatabricksLineageEvidence | value | (client: LakebaseClient, submissionId: string) => Promise<DatabricksLineageEvidenceRow[]> | Join governed object access to the submission actor, outcome, and model/tool cost. |
RagChainPostProcessOptions | type | RagChainPostProcessOptions | Configuration options for rag chain post process. |
RagChainPromptOptions | type | RagChainPromptOptions | Configuration options for rag chain prompt. |
RagEvalExpected | type | RagEvalExpected | Type contract for rag eval expected. |
RagPreprocess | type | RagPreprocess | Type contract for rag preprocess. |
RagStreamEvent | type | RagStreamEvent | Incremental event from DatabricksRagChain.stream. delta events carry raw first-pass model output for live UI. They are emitted before citation validation, bounded repair, truncation, and the sources footer run, so the concatenated deltas may differ from the final validated answer. The terminal turn event is authoritative — use it for persistence, evaluation export, and cost telemetry, exactly like the SDK's ModelStreamChunk.done contract. |
RagTurn | type | RagTurn | Structured result of one online RAG inference turn. Mirrors the Databricks AI Cookbook chain: preprocess → retrieve (AI Search) → prompt augment → generate → post-process. Fabric does not reimplement AI Search or Model Serving — this is a thin orchestration over native Databricks APIs already exposed by this package. |
ragTurnCitationsScorer | value | (name?: string) => (input: { output: RagTurn; }) => RagTurnScore | Runtime API for rag turn citations scorer; the generated signature shows its accepted inputs and return type. |
ragTurnContainsScorer | value | (name?: string) => (input: { case: { expected?: RagEvalExpected | string; }; output: RagTurn; }) => RagTurnScore | Adapter for @fabric-harness/evals scorers when the suite output is a RagTurn. Keep heavy quality judges in Databricks Agent Evaluation; use these for CI smoke. |
RagTurnScore | type | RagTurnScore | Type contract for rag turn score. |
reconcileDatabricksCost | value | (options: DatabricksCostReconciliationOptions) => Promise<DatabricksCostReconciliationResult> | Compare immediate estimates with delayed System Tables actuals and apply an explicit outage policy. |
registerDatabricksModelProvider | value | () => void | Register databricks/<model> model references. |
registerDatabricksSqlSandboxBackend | value | (registration?: DatabricksSqlSandboxRegistrationOptions) => void | Register sandbox: 'databricks' and its credential-safe portable-ref decoder. |
requireDatabricksManagedResource | value | (input: { store: DatabricksManagedResourceStore; resourceType: string; resourceId: string; expectedFingerprint?: string; }) => Promise<DatabricksManagedResourceRecord> | Runtime API for require databricks managed resource; the generated signature shows its accepted inputs and return type. |
resolveDatabricksRequiredChecks | value | (requiredTiers: readonly DatabricksCertificationBlockingTier[], explicitlyRequired?: readonly string[]) => string[] | Resolve blocking-tier checks plus explicit additions. Explicit ids never remove tier defaults. |
resolveToolRefs | value | (bundle: DatabricksBundle, refs: string[]) => ToolDef[] | Resolves tool refs. |
runDatabricksAuthoringLifecycle | value | <Resource, Mutation = Resource>(lifecycle: DatabricksAuthoringLifecycle<Resource, Mutation>, ledger?: DatabricksCertificationCleanupLedger) => Promise<DatabricksAuthoringLifecycleEvidence> | Exercise a destructive authoring capability with mandatory verification and reverse-order cleanup. Callers should perform each operation through the same governed ToolDef path used in production. |
runDatabricksCertification | value | (options: RunDatabricksCertificationOptions) => Promise<DatabricksCertificationEvidence> | Run live capability checks and produce stable, secret-redacted CI evidence. |
RunDatabricksCertificationOptions | type | RunDatabricksCertificationOptions | Configuration options for run databricks certification. |
runDatabricksCommand | value | (command: string, args: readonly string[], options: { cwd: string; env: NodeJS.ProcessEnv; }) => Promise<DatabricksCommandResult> | Runs databricks command. |
RunDatabricksJobInput | type | RunDatabricksJobInput | Type contract for run databricks job input. |
runStatement | value | (client: DatabricksStatementClient, warehouseId: string, statement: string, parameters: SqlParameter[], poll: StatementPoll) => Promise<unknown> | Submit a parameterized SQL statement and poll to a terminal state. Named parameters → injection-safe. |
scoreRagTurn | value | (turn: RagTurn, expected?: RagEvalExpected) => RagTurnScore[] | Lightweight local checks before/alongside Databricks Agent Evaluation. |
serializeDatabricksGenieAgentSpec | value | (spec: DatabricksGenieAgentSpecV2) => Promise<string> | Serializes databricks genie agent spec. |
servingUsageCapture | value | (options: ServingUsageCaptureOptions) => (event: FabricEvent) => void | Build an onEvent fan-in that turns model-usage events into submission_usage telemetry. For every FabricEvent carrying data.usage ({ inputTokens?, outputTokens?, costUsd? }, at least one numeric field) — and optionally data.model — while an ambient currentSubmissionContext is set, it emits one submission_usage event stamped with the submission correlation (submission/attempt ids, agent identity, tenant, actor). Events observed outside a submission context are dropped silently — not every session turn belongs to a submission. The submission context does not carry the... |
ServingUsageCaptureOptions | type | ServingUsageCaptureOptions | Serving usage capture (v2 migration, workstream C7): attribute model/serving spend to submissions through the ambient submission context. |
SqlParameter | type | SqlParameter | Type contract for sql parameter. |
StatementPoll | type | StatementPoll | Type contract for statement poll. |
SubmitDatabricksNotebookInput | type | SubmitDatabricksNotebookInput | Type contract for submit databricks notebook input. |
sweepDatabricksAuthoringCertification | value | (clients: DatabricksCertificationSweepClients, options?: DatabricksCertificationSweepOptions) => Promise<DatabricksCertificationSweepResult> | Remove only resources carrying the reserved protected-certification prefix. |
sweepDatabricksAuthoringCertificationWorkspace | value | (options: DatabricksCertificationWorkspaceSweepOptions) => Promise<DatabricksCertificationSweepResult> | Build the official generated clients plus the private Workspace-object adapter and sweep one workspace. This is the supported operational entrypoint; callers never construct raw transport. |
toAgentEvaluationRecord | value | (turn: RagTurn, options?: { expectedAnswer?: string; tags?: Record<string, string>; }) => LegacyAgentEvaluationRecord | Convert a RagTurn into a Databricks-friendly evaluation record. Upload JSONL of these rows to MLflow / Agent Evaluation rather than building a parallel judge stack in Fabric. |
toMlflow3EvaluationRecord | value | (turn: RagTurn, options?: { expectedAnswer?: string; expectedRetrievedContext?: Array<{ doc_uri?: string; content: string; }>; tags?: Record<string, string>; traceId?: string; submissionId?: string; }) => Mlflow3RagEvaluationRecord | Convert a RAG turn into the structured MLflow 3 evaluation-dataset shape. |
UcVolumesAttachmentStore | value | typeof UcVolumesAttachmentStore | Storage contract for uc volumes attachment. |
UcVolumesAttachmentStoreOptions | type | UcVolumesAttachmentStoreOptions | Unity Catalog Volumes attachment backend (v2 migration, workstream C2). Implements the SDK AttachmentStore contract on a UC Volume via the Databricks Files API, so attachment bytes are governed by Unity Catalog grants like every other Databricks asset. Layout under the volume: See the package declarations for an example. The bare <digest> file holds the raw bytes; the <digest>.json sidecar holds the AttachmentRef metadata and doubles as the record's existence marker: put is first-write-wins per (scope, digest) — when the sidecar already exists the put is a no-op, so... |
unityCatalogTablesTool | value | (client: DatabricksTablesClient, options?: { name?: string; description?: string; }) => ToolDef<{ catalog: string; schema: string; }, unknown> | Model-callable tool or tool factory for unity catalog tables. |
unregisterDatabricksSqlSandboxBackend | value | () => void | Remove both process-local registrations, primarily for tests and controlled shutdown. |
validateDatabricksAppArtifact | value | (options: ValidateDatabricksAppArtifactOptions) => Promise<ValidateDatabricksAppArtifactResult> | Validate an already-built Databricks App artifact without mutating the workspace. |
ValidateDatabricksAppArtifactOptions | type | ValidateDatabricksAppArtifactOptions | Configuration options for validate databricks app artifact. |
ValidateDatabricksAppArtifactResult | type | ValidateDatabricksAppArtifactResult | Result returned by validate databricks app artifact. |
validateDatabricksAppRecoveryEvidence | value | (evidence: DatabricksAppRecoveryEvidence) => void | Assert that App restart evidence proves durable state, approval recovery, and cascade cleanup. |
validateDatabricksAppUserIsolationEvidence | value | (evidence: DatabricksAppUserIsolationEvidence) => void | Assert that retained App evidence proves distinct principals and cross-user denial. |
validateDatabricksCertificationEnvironment | value | (environment: Environment, requiredChecks: readonly string[]) => DatabricksCertificationEnvironmentIssue[] | Return actionable, secret-free preflight failures for a protected certification environment. The certification runner remains authoritative for runtime configuration and service behavior. |
validateDatabricksComputePolicy | value | (policy: DatabricksComputePolicy) => void | Runtime API for validate databricks compute policy; the generated signature shows its accepted inputs and return type. |
validateDatabricksCrossTierEvidence | value | (options: ValidateDatabricksCrossTierEvidenceOptions) => DatabricksCrossTierEvidenceManifest | Fail closed unless Tier R and Tier A exercised the same immutable package tarball and commit. |
ValidateDatabricksCrossTierEvidenceOptions | type | ValidateDatabricksCrossTierEvidenceOptions | Configuration options for validate databricks cross tier evidence. |
validateDatabricksDynamicAgentEvidence | value | (evidence: DatabricksDynamicAgentEvidence) => void | Assert that Tier R exercised hook-authored agents across a real App restart. |
validateDatabricksGenieSqlReferences | value | (spec: DatabricksGenieAgentSpecV2, policy: DatabricksGenieSqlPolicy) => Promise<void> | Runtime API for validate databricks genie sql references; the generated signature shows its accepted inputs and return type. |
validateDatabricksGovernanceDescriptor | value | (tool: ToolDef, required?: boolean) => void | Validate descriptor syntax and that each path can be traversed in the declared input schema. |
validateDatabricksJobRunPolicy | value | (policy: DatabricksJobRunPolicy) => void | Runtime API for validate databricks job run policy; the generated signature shows its accepted inputs and return type. |
validateDatabricksNotebookRunPolicy | value | (policy: DatabricksNotebookRunPolicy) => void | Runtime API for validate databricks notebook run policy; the generated signature shows its accepted inputs and return type. |
validateDatabricksReleaseEvidence | value | (options: ValidateDatabricksReleaseEvidenceOptions) => DatabricksReleaseEvidenceValidation | Fail closed unless retained Databricks evidence proves the exact release commit and artifacts. |
ValidateDatabricksReleaseEvidenceOptions | type | ValidateDatabricksReleaseEvidenceOptions | Configuration options for validate databricks release evidence. |
validateDatabricksRollingEvidence | value | (options: ValidateDatabricksRollingEvidenceOptions) => DatabricksRollingEvidenceReport | Require daily Tier R evidence plus at least two same-candidate Tier R/A proofs in the rolling public-claim window. Every Tier R record must bind two-user App isolation. |
ValidateDatabricksRollingEvidenceOptions | type | ValidateDatabricksRollingEvidenceOptions | Configuration options for validate databricks rolling evidence. |
validateJobSpec | value | (spec: DatabricksJobSpec, policy: DatabricksComputePolicy) => void | Runtime API for validate job spec; the generated signature shows its accepted inputs and return type. |
withGovernance | value | <I, O>(tool: ToolDef<I, O>, options?: DatabricksGovernanceOptions) => ToolDef<I, O> | Wraps one Databricks tool to stamp lineage/audit and enforce the optional catalog allowlist. |
withGovernanceTools | value | (tools: ToolDef[], options?: DatabricksGovernanceOptions) => ToolDef[] | Wraps a set of Databricks tools with withGovernance. |
@fabric-harness/databricks/agent
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
defineDatabricksAgent | value | <TInput = JsonObject, TOutput = unknown>(options?: DefineDatabricksAgentOptions<TInput, TOutput>) => DefinedAgent<TInput, TOutput> | Defines databricks agent. |
DefineDatabricksAgentOptions | type | DefineDatabricksAgentOptions<TInput, TOutput> | Configuration options for define databricks agent. |
resolveToolRefs | value | (bundle: DatabricksBundle, refs: string[]) => ToolDef[] | Resolves tool refs. |
@fabric-harness/databricks/sql-sandbox
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
databricksSqlSandbox | value | (options: DatabricksSqlSandboxOptions) => SandboxEnv | Sandbox adapter for databricks sql. |
DatabricksSqlSandboxOptions | type | DatabricksSqlSandboxOptions | Sandbox backend that maps exec(command) to a Databricks SQL Statement Execution API call against a SQL Warehouse. Useful for data agents whose "shell" is a query interface. Behavior: - exec(sql) runs the SQL synchronously (with a timeout) and returns the serialized result set as stdout (newline-delimited JSON rows by default, or CSV when resultFormat: 'csv'). - File operations are intentionally minimal: the sandbox-virtual filesystem keeps a small in-memory map. SQL warehouses are not file servers; mount actual data via databricksVolumeSource from @fabric-harness/connectors. Usa... |
DatabricksSqlSandboxRefData | type | DatabricksSqlSandboxRefData | Type contract for databricks sql sandbox ref data. |
DatabricksSqlSandboxRegistrationOptions | type | DatabricksSqlSandboxRegistrationOptions | Configuration options for databricks sql sandbox registration. |
registerDatabricksSqlSandboxBackend | value | (registration?: DatabricksSqlSandboxRegistrationOptions) => void | Register sandbox: 'databricks' and its credential-safe portable-ref decoder. |
unregisterDatabricksSqlSandboxBackend | value | () => void | Remove both process-local registrations, primarily for tests and controlled shutdown. |
@fabric-harness/databricks/app-user-authorization
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
createDatabricksAppUserAuthenticator | value | (options: DatabricksAppUserAuthenticatorOptions) => (request: { headers: Headers | Record<string, string | string[] | undefined>; }) => Promise<DatabricksAppAuthenticatedPrincipal | false | undefined> | Authenticate Databricks Apps forwarded user tokens and isolate each user by default. Validation calls the workspace current-user API once per token digest; raw tokens are never stored as cache keys or returned to Fabric Harness. |
DATABRICKS_APP_USER_PERMISSIONS | value | readonly ["agent:invoke", "approval:read", "approval:write", "artifact:read", "mcp:invoke", "session:abort", "session:delete", "session:read"] | Constant defining databricks app user permissions. |
DatabricksAppAuthenticatedPrincipal | type | DatabricksAppAuthenticatedPrincipal | Type contract for databricks app authenticated principal. |
DatabricksAppUserAuthenticatorOptions | type | DatabricksAppUserAuthenticatorOptions | Configuration options for databricks app user authenticator. |
DatabricksAppUserAuthorizationInspection | type | DatabricksAppUserAuthorizationInspection | Type contract for databricks app user authorization inspection. |
databricksPrincipalTenantId | value | (kind: "user" | "service-principal" | "app", id: string) => string | Stable, non-reversible tenant scope for Databricks App principals. |
inspectDatabricksAppUserAuthorization | value | (options: { headers: Headers | Record<string, string | string[] | undefined>; host: string; fetchImpl?: typeof fetch; now?: () => number; }) => Promise<DatabricksAppUserAuthorizationInspection> | Validate a Databricks Apps forwarded user token and return non-secret identity/lifetime metadata suitable for OBO lifecycle certification. The access token is never returned or included in an error. |
@fabric-harness/databricks/platform
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
createDatabricksMutationGovernanceResolver | value | (options: DatabricksMutationGovernanceOptions) => MutationGovernanceResolver | Platform resolver backed by Databricks resource identities but no Databricks network calls. |
DATABRICKS_PLATFORM_GOVERNANCE_BRIDGE_VERSION | value | "1" | Durable generation of the Harness-to-Platform Databricks governance bridge. |
DatabricksAttestationInput | type | DatabricksAttestationInput | Type contract for databricks attestation input. |
databricksExecutionAttestation | value | (input: DatabricksAttestationInput) => ExecutionAttestation | Runtime API for databricks execution attestation; the generated signature shows its accepted inputs and return type. |
databricksExecutionPrincipal | value | (principal: DatabricksPrincipal, delegatedBy?: ExecutionPrincipal, explicitId?: string) => ExecutionPrincipal | Audit-safe Databricks identity. Tokens and secrets are deliberately never represented. |
databricksGovernanceRuntimeEvidence | value | (overrides?: Pick<GovernanceRuntimeEvidence, "hostPackageVersion" | "policyRulesetVersion">) => Partial<GovernanceRuntimeEvidence> | Runtime evidence applications pass directly to createGovernedActionHost. |
DatabricksMutationGovernanceOptions | type | DatabricksMutationGovernanceOptions | Configuration options for databricks mutation governance. |
DatabricksPlatformResource | type | DatabricksPlatformResource | Type contract for databricks platform resource. |
databricksPlatformResourceRef | value | (workspaceHost: string, resource: Omit<DatabricksPlatformResource, "operation" | "dataClassifications">) => ExternalResourceRef | Runtime API for databricks platform resource ref; the generated signature shows its accepted inputs and return type. |
@fabric-harness/databricks/runtime
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
chooseDatabricksSqlWarehouse | value | (warehouses: readonly DatabricksSqlWarehouse[]) => DatabricksSqlWarehouse | undefined | Runtime API for choose databricks sql warehouse; the generated signature shows its accepted inputs and return type. |
createDatabricksAuthenticatedFetch | value | (options: DatabricksAuthenticatedFetchOptions) => typeof fetch | Fetch adapter for third-party SDKs that require a standard fetch surface. A fresh principal token is resolved per attempt and one auth refresh retry is bounded to 401/403. |
databricksAnthropicGatewayBaseUrl | value | (host: string) => string | Runtime API for databricks anthropic gateway base url; the generated signature shows its accepted inputs and return type. |
DatabricksAuthenticatedFetchOptions | type | DatabricksAuthenticatedFetchOptions | Configuration options for databricks authenticated fetch. |
databricksControlPlane | value | (options: DatabricksControlPlaneOptions) => { aiGateway: { ensure: () => Promise<void>; listModelServices: (discoveryOptions?: DatabricksModelServiceDiscoveryOptions) => Promise<DatabricksModelService[]>; listModelProviderServices: () => Promi... | A compact Databricks control-plane client that deliberately excludes Harness build, deployment, and agent-authoring code. Use this entrypoint from application bundles such as Next.js. |
DatabricksControlPlaneOptions | type | DatabricksControlPlaneOptions | Runtime-only control-plane configuration for applications and server frameworks. |
databricksIdentity | value | (principal: DatabricksPrincipal) => DatabricksTokenProvider | Builds a rotating bearer-token provider from the same native credential used by SDK clients. |
DatabricksModelProviderService | type | DatabricksModelProviderService | Type contract for databricks model provider service. |
databricksModelProviderSupportsAnthropic | value | (service: DatabricksModelProviderService) => boolean | Runtime API for databricks model provider supports anthropic; the generated signature shows its accepted inputs and return type. |
DatabricksModelService | type | DatabricksModelService | Type contract for databricks model service. |
DatabricksModelServiceDiscoveryOptions | type | DatabricksModelServiceDiscoveryOptions | Configuration options for databricks model service discovery. |
DatabricksPrincipal | type | DatabricksPrincipal | Type contract for databricks principal. |
databricksPrincipalFromEnv | value | (env?: Record<string, string | undefined>, options?: DatabricksPrincipalEnvOptions) => Extract<DatabricksPrincipal, { kind: "pat" | "service-principal" | "cli-profile"; }> | Resolve a PAT or OAuth M2M principal consistently across CLIs, recipes, Apps, and tests. |
databricksSdk | value | (options: DatabricksSdkOptions) => DatabricksSdkClients | Build the official modular Databricks SDK clients under one governed identity. SDK-gap protocols remain private to Fabric's explicit raw protocol adapters. |
DatabricksSdkClients | type | DatabricksSdkClients | Generated Databricks service clients exposed to application code. |
DatabricksSdkOptions | type | DatabricksSdkOptions | Configuration options for databricks sdk. |
DatabricksSqlWarehouse | type | DatabricksSqlWarehouse | Type contract for databricks sql warehouse. |
DatabricksTokenProvider | type | DatabricksTokenProvider | A bearer-token resolver awaited per request. Fabric uses the same native-SDK credential across generated service clients, model calls, preview streaming, and Lakebase credential exchange. |
databricksWorkspaceOrigin | value | (host: string) => string | Normalize a workspace hostname or URL to its HTTPS origin. |
lakebaseCredentialProvider | value | (options: LakebaseCredentialProviderOptions) => () => Promise<string> | Exchange a workspace OAuth token for a Lakebase database credential. The result is cached, refreshed early with jitter, and refreshes are single-flight. |
parseStatementRows | value | (response: unknown) => JsonObject[] | Map a statement response's columns + rows into objects keyed by column name. |
runStatement | value | (client: DatabricksStatementClient, warehouseId: string, statement: string, parameters: SqlParameter[], poll: StatementPoll) => Promise<unknown> | Submit a parameterized SQL statement and poll to a terminal state. Named parameters → injection-safe. |
SqlParameter | type | SqlParameter | Type contract for sql parameter. |
StatementPoll | type | StatementPoll | Type contract for statement poll. |
@fabric-harness/node
@fabric-harness/node
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
AgentDescription | type | AgentDescription | Type contract for agent description. |
AgentModule | type | AgentModule | Type contract for agent module. |
AgentNotFoundError | value | typeof AgentNotFoundError | Error raised for agent not found failures. |
AgentSummary | type | AgentSummary | Type contract for agent summary. |
applyEnvModelProvider | value | (options: AgentInit, env?: NodeJS.ProcessEnv, modelOptions?: EnvModelOptions) => AgentInit | Provider implementation for apply env model. |
ApprovalSummary | type | ApprovalSummary | Type contract for approval summary. |
asJsonObject | value | (value: unknown) => JsonObject | Runtime API for as json object; the generated signature shows its accepted inputs and return type. |
assertDataResidency | value | (region: string, allowedRegions: readonly string[]) => void | Validates data residency and throws when the requirement is not met. |
BackupObjectStore | type | BackupObjectStore | Storage contract for backup object. |
backupPostgresPersistence | value | (input: { client: PostgresClientLike; objectStore: BackupObjectStore; objectKey: string; tablePrefix?: string; }) => Promise<PostgresBackupRecord> | Create a transactionally consistent logical backup and write it to object storage. |
BuildBundleStrategy | type | BuildBundleStrategy | Type contract for build bundle strategy. |
BuildManifest | type | BuildManifest | Type contract for build manifest. |
BuildManifestAgent | type | BuildManifestAgent | Type contract for build manifest agent. |
BuildManifestFile | type | BuildManifestFile | Type contract for build manifest file. |
BuildManifestRole | type | BuildManifestRole | Type contract for build manifest role. |
BuildManifestSkill | type | BuildManifestSkill | Type contract for build manifest skill. |
BuildSummary | type | BuildSummary | Type contract for build summary. |
BuildTarget | type | BuildTarget | Type contract for build target. |
buildWorkspace | value | (options?: BuildWorkspaceOptions) => Promise<BuildWorkspaceResult> | Runtime API for build workspace; the generated signature shows its accepted inputs and return type. |
BuildWorkspaceOptions | type | BuildWorkspaceOptions | Configuration options for build workspace. |
BuildWorkspaceResult | type | BuildWorkspaceResult | Result returned by build workspace. |
cancelSessionTask | value | (workspaceRoot: string, sessionId: string, taskId: string, reason?: string, actor?: string) => Promise<TaskSummary> | Runtime API for cancel session task; the generated signature shows its accepted inputs and return type. |
cancelTaskInStore | value | (store: SessionStore, sessionId: string, taskId: string, reason?: string, actor?: string) => Promise<TaskSummary> | Storage contract for cancel task in. |
CheckpointSummary | type | CheckpointSummary | Type contract for checkpoint summary. |
compactPersistedSession | value | (workspaceRoot: string, sessionId: string, options?: CompactPersistedSessionOptions) => Promise<PersistedCompactionResult> | Runtime API for compact persisted session; the generated signature shows its accepted inputs and return type. |
CompactPersistedSessionOptions | type | CompactPersistedSessionOptions | Configuration options for compact persisted session. |
compactSessionInStore | value | (store: SessionStore, sessionId: string, options?: CompactPersistedSessionOptions) => Promise<PersistedCompactionResult> | Storage contract for compact session in. |
createConfiguredSessionStore | value | (options: CreateConfiguredSessionStoreOptions) => Promise<SessionStore> | Creates configured session store. |
CreateConfiguredSessionStoreOptions | type | CreateConfiguredSessionStoreOptions | Configuration options for create configured session store. |
createFabricRunContext | value | (options: CreateFabricRunContextOptions) => Promise<FabricContext> | Creates fabric run context. |
CreateFabricRunContextOptions | type | CreateFabricRunContextOptions | Configuration options for create fabric run context. |
createMcpHttpServer | value | (tools: ToolDef[], options?: FabricMcpHttpServerOptions) => Promise<FabricMcpHttpServer> | Expose governed Harness tools through stateless MCP Streamable HTTP. |
createPersistentDispatchProcessor | value | (options: PersistentDispatchProcessorOptions) => DispatchProcessor | Build a DispatchProcessor that applies dispatched inputs to a persistent instance session. Idempotent by dispatchId: a marker entry is appended to the instance session after a dispatch is applied, and re-delivery of the same dispatchId is skipped. The marker lives in the shared session store, so dedup holds across separate processings (and survives restart when the store is durable). |
createPersistentSubmissionExecutor | value | (options: PersistentSubmissionExecutorOptions) => SubmissionExecutor | The SubmissionExecutor that applies durable submissions to persistent instance sessions. execute runs a real session turn (session.prompt is idempotent by submission id, so a recovered attempt resumes instead of double-applying its input); everything else operates store-level so reconciliation never needs a live agent. |
createPrivateNetworkFetch | value | (options?: PrivateNetworkFetchOptions) => PrivateNetworkFetchClient | Create an outbound Node client with one policy and transport trust path. Credentials and PEM material remain in the dispatcher and are never placed in request URLs, Fabric events, or model messages. |
createResponsesDeltaEvent | value | (itemId: string, delta: string) => JsonObject | Creates responses delta event. |
createResponsesDoneEvent | value | (itemId: string, text: string) => JsonObject | Creates responses done event. |
createResponsesOutputItem | value | (itemId: string, text: string) => FabricResponsesOutputItem | Creates responses output item. |
createResponsesResponse | value | (input: { submissionId: string; itemId: string; text: string; customOutputs?: JsonObject; includeTraceId?: boolean; }) => JsonObject | Creates responses response. |
currentMcpRequestContext | value | () => FabricMcpRequestContext | Runtime API for current mcp request context; the generated signature shows its accepted inputs and return type. |
databricksAppsOidcAuthenticator | value | (options: DatabricksAppsOidcAuthenticatorOptions) => (request: IncomingMessage) => Promise<ServerPrincipal | false | undefined> | Databricks workspace OIDC preset for Apps ingress and workspace-scoped RBAC claims. |
DatabricksAppsOidcAuthenticatorOptions | type | DatabricksAppsOidcAuthenticatorOptions | Configuration options for databricks apps oidc authenticator. |
daytona | value | (config: DaytonaBundleConfig, isMock?: boolean) => DaytonaBundle | One-call wiring for a Daytona-native agent: resolves the model provider from config or env, includes Daytona-specific workspace tools, and sets a safe default egress policy. |
DaytonaBundle | type | DaytonaBundle | Type contract for daytona bundle. |
DaytonaBundleConfig | type | DaytonaBundleConfig | Type contract for daytona bundle config. |
defineApplication | value | (application: FabricApplication) => FabricApplication | Identity helper that preserves route/middleware inference in workspace config. |
defineDaytonaAgent | value | (options?: DefineDaytonaAgentOptions) => DefinedAgent<JsonObject, unknown> | Defines daytona agent. |
DefineDaytonaAgentOptions | type | DefineDaytonaAgentOptions | Configuration options for define daytona agent. |
defineDockerAgent | value | (options?: DefineDockerAgentOptions) => DefinedAgent<JsonObject, unknown> | Defines docker agent. |
DefineDockerAgentOptions | type | DefineDockerAgentOptions | Configuration options for define docker agent. |
defineE2bAgent | value | (options?: DefineE2bAgentOptions) => DefinedAgent<JsonObject, unknown> | Defines e2b agent. |
DefineE2bAgentOptions | type | DefineE2bAgentOptions | Configuration options for define e2b agent. |
defineK8sAgent | value | (options?: DefineK8sAgentOptions) => DefinedAgent<JsonObject, unknown> | Defines k8s agent. |
DefineK8sAgentOptions | type | DefineK8sAgentOptions | Configuration options for define k8s agent. |
defineModalAgent | value | (options?: DefineModalAgentOptions) => DefinedAgent<JsonObject, unknown> | Defines modal agent. |
DefineModalAgentOptions | type | DefineModalAgentOptions | Configuration options for define modal agent. |
defineNodeAgent | value | (options?: DefineNodeAgentOptions) => DefinedAgent<JsonObject, unknown> | Defines node agent. |
DefineNodeAgentOptions | type | DefineNodeAgentOptions | Configuration options for define node agent. |
DeletionEvidenceSigner | type | DeletionEvidenceSigner | Type contract for deletion evidence signer. |
DeletionEvidenceStore | type | DeletionEvidenceStore | Storage contract for deletion evidence. |
describeAgentFile | value | (options: LoadAgentModuleOptions) => Promise<AgentDescription> | Runtime API for describe agent file; the generated signature shows its accepted inputs and return type. |
DevServerHandle | type | DevServerHandle | Type contract for dev server handle. |
DevServerOptions | type | DevServerOptions | Configuration options for dev server. |
discoverWorkspace | value | (startDir?: string) => Promise<WorkspaceInfo> | Runtime API for discover workspace; the generated signature shows its accepted inputs and return type. |
docker | value | (config: DockerBundleConfig, isMock?: boolean) => DockerBundle | One-call wiring for a Docker-native agent: resolves the model provider from config or env, includes Docker-specific container tools, and sets a safe default egress policy. |
DockerBundle | type | DockerBundle | Type contract for docker bundle. |
DockerBundleConfig | type | DockerBundleConfig | Type contract for docker bundle config. |
e2b | value | (config: E2bBundleConfig, isMock?: boolean) => E2bBundle | One-call wiring for an E2B-native agent: resolves the model provider from config or env, includes built-in tools, and sets a safe default egress policy. |
E2bBundle | type | E2bBundle | Type contract for e2b bundle. |
E2bBundleConfig | type | E2bBundleConfig | Type contract for e2b bundle config. |
ed25519DeletionEvidenceSigner | value | (options: { privateKey: KeyObject | string | Buffer; identityKey: string | Uint8Array; keyId: string; }) => DeletionEvidenceSigner | Runtime API for ed25519 deletion evidence signer; the generated signature shows its accepted inputs and return type. |
enforcePersistenceRetention | value | (persistence: PersistenceBundle, policy: FabricRetentionPolicy, options?: { now?: Date; }) => Promise<RetentionResult> | Enforce durable data retention. Use a deletion-evidence-wrapped bundle for signed session receipts. |
ensurePostgresAttachmentTables | value | (client: PostgresClientLike) => Promise<void> | Create the attachments table when absent. Idempotent. |
ensurePostgresConversationStreamTables | value | (client: PostgresClientLike) => Promise<void> | Create the conversation stream tables when absent. Idempotent. |
ensurePostgresSubmissionTables | value | (client: PostgresClientLike) => Promise<void> | Create the submission tables and indexes when absent. Idempotent. |
ensureSqliteAttachmentTables | value | (db: SqliteDatabaseLike) => void | Create the attachments table when absent. Idempotent. |
ensureSqliteConversationStreamTables | value | (db: SqliteDatabaseLike) => void | Create the conversation stream tables when absent. Idempotent. |
ensureSqliteSubmissionTables | value | (db: SqliteDatabaseLike) => void | Create the submission tables and indexes when absent. Idempotent. |
entraIdAuthenticator | value | (options: EntraIdAuthenticatorOptions) => (request: IncomingMessage) => Promise<ServerPrincipal | false | undefined> | Microsoft Entra ID v2 preset with tenant, roles, groups, and app/user identity mapping. |
EntraIdAuthenticatorOptions | type | EntraIdAuthenticatorOptions | Configuration options for entra id authenticator. |
ExternalRetentionTarget | type | ExternalRetentionTarget | Type contract for external retention target. |
FabricApplication | type | FabricApplication | Type contract for fabric application. |
FabricApplicationMiddleware | type | FabricApplicationMiddleware | Middleware for fabric application. |
FabricApplicationNext | type | FabricApplicationNext | Type contract for fabric application next. |
FabricApplicationPublicMiddleware | type | FabricApplicationPublicMiddleware | Middleware for fabric application public. |
FabricApplicationPublicRequestContext | type | FabricApplicationPublicRequestContext | Type contract for fabric application public request context. |
FabricApplicationRequestContext | type | FabricApplicationRequestContext | Type contract for fabric application request context. |
FabricApplicationRoute | type | FabricApplicationRoute | Type contract for fabric application route. |
FabricApplicationStores | type | FabricApplicationStores | Type contract for fabric application stores. |
FabricBuildContext | type | FabricBuildContext | Type contract for fabric build context. |
FabricBuildError | value | typeof FabricBuildError | Error raised for fabric build failures. |
FabricBuildErrorCode | type | FabricBuildErrorCode | Type contract for fabric build error code. |
FabricBuildPlugin | type | FabricBuildPlugin | Type contract for fabric build plugin. |
FabricHarnessConfig | type | FabricHarnessConfig | Type contract for fabric harness config. |
FabricHarnessDatabricksAiSearchAppResourceConfig | type | FabricHarnessDatabricksAiSearchAppResourceConfig | Type contract for fabric harness databricks ai search app resource config. |
FabricHarnessDatabricksAppConfig | type | FabricHarnessDatabricksAppConfig | Type contract for fabric harness databricks app config. |
FabricHarnessDatabricksAppResourceApp | type | FabricHarnessDatabricksAppResourceApp | Type contract for fabric harness databricks app resource app. |
FabricHarnessDatabricksAppResourceConfig | type | FabricHarnessDatabricksAppResourceConfig | A Databricks-native App resource plus its app.yaml environment projection. Native field and permission names intentionally match the Databricks Bundle schema. |
FabricHarnessDatabricksAppResourceDatabase | type | FabricHarnessDatabricksAppResourceDatabase | Type contract for fabric harness databricks app resource database. |
FabricHarnessDatabricksAppResourceExperiment | type | FabricHarnessDatabricksAppResourceExperiment | Type contract for fabric harness databricks app resource experiment. |
FabricHarnessDatabricksAppResourceGenieSpace | type | FabricHarnessDatabricksAppResourceGenieSpace | Type contract for fabric harness databricks app resource genie space. |
FabricHarnessDatabricksAppResourceJob | type | FabricHarnessDatabricksAppResourceJob | Type contract for fabric harness databricks app resource job. |
FabricHarnessDatabricksAppResourceKind | type | "postgres" | "app" | "database" | "experiment" | "genie_space" | "job" | "secret" | "serving_endpoint" | "sql_warehouse" | "uc_securable" | Type contract for fabric harness databricks app resource kind. |
FabricHarnessDatabricksAppResourcePostgres | type | FabricHarnessDatabricksAppResourcePostgres | Type contract for fabric harness databricks app resource postgres. |
FabricHarnessDatabricksAppResourceSecret | type | FabricHarnessDatabricksAppResourceSecret | Type contract for fabric harness databricks app resource secret. |
FabricHarnessDatabricksAppResourceServingEndpoint | type | FabricHarnessDatabricksAppResourceServingEndpoint | Type contract for fabric harness databricks app resource serving endpoint. |
FabricHarnessDatabricksAppResourceSqlWarehouse | type | FabricHarnessDatabricksAppResourceSqlWarehouse | Type contract for fabric harness databricks app resource sql warehouse. |
FabricHarnessDatabricksAppResourceUcSecurable | type | FabricHarnessDatabricksAppResourceUcSecurable | Type contract for fabric harness databricks app resource uc securable. |
FabricHarnessDatabricksConfig | type | FabricHarnessDatabricksConfig | Type contract for fabric harness databricks config. |
FabricHarnessDatabricksGenieAppResourceConfig | type | FabricHarnessDatabricksGenieAppResourceConfig | Type contract for fabric harness databricks genie app resource config. |
FabricHarnessDatabricksServingConfig | type | FabricHarnessDatabricksServingConfig | Type contract for fabric harness databricks serving config. |
FabricHarnessEnvironmentConfig | type | FabricHarnessEnvironmentConfig | Type contract for fabric harness environment config. |
FabricHarnessPersistenceConfig | type | FabricHarnessPersistenceConfig | Type contract for fabric harness persistence config. |
FabricHarnessSandboxConfig | type | FabricHarnessSandboxConfig | Type contract for fabric harness sandbox config. |
FabricHarnessStoreConfig | type | FabricHarnessStoreConfig | Type contract for fabric harness store config. |
FabricHarnessTemporalConfig | type | FabricHarnessTemporalConfig | Type contract for fabric harness temporal config. |
FabricMcpHttpServer | type | FabricMcpHttpServer | Type contract for fabric mcp http server. |
FabricMcpHttpServerOptions | type | FabricMcpHttpServerOptions | Configuration options for fabric mcp http server. |
FabricMcpRequestContext | type | FabricMcpRequestContext | Type contract for fabric mcp request context. |
FabricMcpToolContextRequest | type | FabricMcpToolContextRequest | Input contract for fabric mcp tool context. |
FabricMcpToolContextResolution | type | FabricMcpToolContextResolution | Type contract for fabric mcp tool context resolution. |
FabricPersistence | type | FabricPersistence | Type contract for fabric persistence. |
FabricPersistenceError | value | typeof FabricPersistenceError | Error raised for fabric persistence failures. |
FabricPersistenceErrorCode | type | FabricPersistenceErrorCode | Type contract for fabric persistence error code. |
FabricPersistenceHealth | type | PersistenceHealth | Type contract for fabric persistence health. |
fabricPostgresMigrations | value | (tablePrefix?: string) => PostgresMigration[] | Runtime API for fabric postgres migrations; the generated signature shows its accepted inputs and return type. |
FabricResponsesConfig | type | FabricResponsesConfig | Type contract for fabric responses config. |
FabricResponsesInputItem | type | FabricResponsesInputItem | Type contract for fabric responses input item. |
FabricResponsesOutputItem | type | FabricResponsesOutputItem | Type contract for fabric responses output item. |
FabricResponsesRequest | type | FabricResponsesRequest | Input contract for fabric responses. |
FabricRetentionPolicy | type | FabricRetentionPolicy | Type contract for fabric retention policy. |
FileAttachmentStore | value | typeof FileAttachmentStore | Storage contract for file attachment. |
FileAttachmentStoreOptions | type | FileAttachmentStoreOptions | Configuration options for file attachment store. |
FileConversationStreamStore | value | typeof FileConversationStreamStore | Storage contract for file conversation stream. |
FileConversationStreamStoreOptions | type | FileConversationStreamStoreOptions | Configuration options for file conversation stream store. |
FileSessionStore | value | typeof FileSessionStore | Storage contract for file session. |
FileSessionStoreOptions | type | FileSessionStoreOptions | Configuration options for file session store. |
findWorkspaceRoot | value | (startDir?: string) => Promise<string> | Runtime API for find workspace root; the generated signature shows its accepted inputs and return type. |
forkSessionAtStep | value | (store: SessionStore, sourceSessionId: string, stepId: string, options?: { newSessionId: string; metadata?: JsonObject; }) => Promise<ForkSessionAtStepResult> | Forks a session at the given step into a new session in the same store. The new session contains the active-path entries up to and including stepId, and its leafId is set to stepId. Used by fh replay --rerun. If a user_prompt entry exists immediately after the cut on the original active path, its text is returned as resumePromptText so the caller can resubmit it against the forked session. |
ForkSessionAtStepResult | type | ForkSessionAtStepResult | Result returned by fork session at step. |
getMetricsFromStore | value | (store: SessionStore, sessionId: string) => Promise<SessionMetrics | undefined> | Returns metrics from store. |
getRequiredAgentDefinition | value | (value: unknown, agentPath: string) => AgentDefinition<unknown, unknown> | Returns required agent definition. |
getSessionApprovalState | value | (workspaceRoot: string, sessionId: string, approvalId: string) => Promise<ApprovalState | undefined> | Returns session approval state. |
getSessionArtifact | value | (workspaceRoot: string, sessionId: string, artifactIdOrName: string) => Promise<{ ref: ArtifactRef; content: Uint8Array; } | undefined> | Returns session artifact. |
getSessionMetrics | value | (workspaceRoot: string, sessionId: string) => Promise<SessionMetrics | undefined> | Returns session metrics. |
getSessionTask | value | (workspaceRoot: string, sessionId: string, taskId: string) => Promise<TaskSummary | undefined> | Returns session task. |
getSessionTimeline | value | (workspaceRoot: string, sessionId: string) => Promise<SessionTimeline | undefined> | Returns session timeline. |
getTaskFromStore | value | (store: SessionStore, sessionId: string, taskId: string) => Promise<TaskSummary | undefined> | Returns task from store. |
hmacDeletionEvidenceSigner | value | (options: { key: string | Uint8Array; keyId: string; }) => DeletionEvidenceSigner | Runtime API for hmac deletion evidence signer; the generated signature shows its accepted inputs and return type. |
httpBackupObjectStore | value | (options: { urlForKey: (key: string) => string | URL; headers?: (method: "GET" | "PUT", key: string, metadata?: Record<string, string>) => BackupHeadersInit | Promise<BackupHeadersInit>; fetch?: typeof globalThis.fetch; }) => BackupObjectStore | HTTP PUT/GET object store for presigned S3/R2, Azure Blob SAS, or an internal object gateway. |
HttpRateLimitClass | type | HttpRateLimitClass | Type contract for http rate limit class. |
HttpRateLimitConfig | type | HttpRateLimitConfig | Type contract for http rate limit config. |
HttpRateLimitContext | type | HttpRateLimitContext | Type contract for http rate limit context. |
HttpRateLimitDecision | type | HttpRateLimitDecision | Type contract for http rate limit decision. |
HttpRateLimiter | type | HttpRateLimiter | Type contract for http rate limiter. |
HttpRateLimitRule | type | HttpRateLimitRule | Type contract for http rate limit rule. |
inspectReplay | value | (workspaceRoot: string, sessionId: string) => Promise<ReplayInspection | undefined> | Runtime API for inspect replay; the generated signature shows its accepted inputs and return type. |
inspectReplayFromStore | value | (store: SessionStore, sessionId: string) => Promise<ReplayInspection | undefined> | Storage contract for inspect replay from. |
inspectSession | value | (workspaceRoot: string, sessionId: string) => Promise<SessionData | undefined> | Runtime API for inspect session; the generated signature shows its accepted inputs and return type. |
inspectSessionFromStore | value | (store: SessionStore, sessionId: string) => Promise<SessionData | undefined> | Storage contract for inspect session from. |
isDefinedAgent | value | (value: unknown) => value is DefinedAgent | Checks whether a value is defined agent. |
isPersistentAgent | value | (workspaceRoot: string, agent: string) => Promise<boolean> | Checks whether a value is persistent agent. |
JobScheduler | type | JobScheduler | Type contract for job scheduler. |
JobSchedulerOptions | type | JobSchedulerOptions | Configuration options for job scheduler. |
k8s | value | (config: K8sBundleConfig, isMock?: boolean) => K8sBundle | One-call wiring for a Kubernetes-native agent: resolves the model provider from config or env, includes K8s-specific kubectl tools, and sets a safe default egress policy. |
K8sBundle | type | K8sBundle | Type contract for k8s bundle. |
K8sBundleConfig | type | K8sBundleConfig | Type contract for k8s bundle config. |
libsqlPersistence | value | (options: LibSqlPersistenceOptions) => FabricPersistence | Full local libSQL or remote Turso bundle using optimistic version fencing. |
LibSqlPersistenceClient | type | LibSqlPersistenceClient | Client implementation for lib sql persistence. |
LibSqlPersistenceOptions | type | LibSqlPersistenceOptions | Configuration options for lib sql persistence. |
LibSqlResultSet | type | LibSqlResultSet | Type contract for lib sql result set. |
listAgentFiles | value | (workspaceRoot: string) => Promise<string[]> | Lists agent files. |
listAgentSummaries | value | (workspaceRoot: string) => Promise<AgentSummary[]> | Lists agent summaries. |
listApprovalsFromStore | value | (store: SessionStore, sessionId: string) => Promise<ApprovalSummary[]> | Lists approvals from store. |
listApprovalStatesFromStore | value | (store: SessionStore, sessionId: string) => Promise<import("@fabric-harness/sdk").ApprovalState[]> | Lists approval states from store. |
listBuilds | value | (workspaceRoot: string) => Promise<BuildSummary[]> | Lists builds. |
listCheckpointsFromStore | value | (store: SessionStore, sessionId: string) => Promise<CheckpointSummary[]> | Lists checkpoints from store. |
listSessionApprovals | value | (workspaceRoot: string, sessionId: string) => Promise<ApprovalSummary[]> | Lists session approvals. |
listSessionApprovalStates | value | (workspaceRoot: string, sessionId: string) => Promise<ApprovalState[]> | Lists session approval states. |
listSessionArtifacts | value | (workspaceRoot: string, sessionId: string) => Promise<ArtifactRef[]> | Lists session artifacts. |
listSessionCheckpoints | value | (workspaceRoot: string, sessionId: string) => Promise<CheckpointSummary[]> | Lists session checkpoints. |
listSessions | value | (workspaceRoot: string) => Promise<SessionSummary[]> | Lists sessions. |
listSessionSummariesFromStore | value | (store: SessionStore, options?: ListSessionSummariesOptions) => Promise<SessionSummary[]> | Lists session summaries from store. |
listSessionTasks | value | (workspaceRoot: string, sessionId: string) => Promise<TaskSummary[]> | Lists session tasks. |
listTasksFromStore | value | (store: SessionStore, sessionId: string) => Promise<TaskSummary[]> | Lists tasks from store. |
loadAgentModule | value | (options: LoadAgentModuleOptions) => Promise<AgentModule> | Loads agent module. |
LoadAgentModuleOptions | type | LoadAgentModuleOptions | Configuration options for load agent module. |
loadFabricHarnessConfig | value | (options: LoadFabricHarnessConfigOptions) => Promise<FabricHarnessConfig> | Loads fabric harness config. |
LoadFabricHarnessConfigOptions | type | LoadFabricHarnessConfigOptions | Configuration options for load fabric harness config. |
loadRoles | value | (workspaceRoot: string) => Promise<Role[]> | Loads roles. |
loadSkills | value | (workspaceRoot: string) => Promise<Skill[]> | Loads skills. |
mapOidcPrincipal | value | (context: OidcPrincipalContext, options: Pick<OidcJwtAuthenticatorOptions, "claims" | "groupRoles" | "rolePermissions" | "provider">) => ServerPrincipal | false | Runtime API for map oidc principal; the generated signature shows its accepted inputs and return type. |
memoryDeletionEvidenceStore | value | () => DeletionEvidenceStore | Storage contract for memory deletion evidence. |
memoryPersistence | value | () => FabricPersistence | Infrastructure-free unified bundle for tests and lightweight applications. |
memorySchedulerLeaseStore | value | () => SchedulerLeaseStore | Storage contract for memory scheduler lease. |
migratePostgresPersistence | value | (client: PostgresClientLike, options?: { tablePrefix?: string; migrations?: PostgresMigration[]; targetVersion?: number; }) => Promise<PostgresMigrationResult> | Runtime API for migrate postgres persistence; the generated signature shows its accepted inputs and return type. |
MockDaytonaModelProvider | value | typeof MockDaytonaModelProvider | A deterministic ModelProvider for Daytona agent tests and init templates. Returns structured responses without requiring real API credentials. |
MockDaytonaModelProviderOptions | type | MockDaytonaModelProviderOptions | Configuration options for mock daytona model provider. |
MockDockerModelProvider | value | typeof MockDockerModelProvider | A deterministic ModelProvider for Docker agent tests and init templates. Returns structured responses without requiring real API credentials. |
MockDockerModelProviderOptions | type | MockDockerModelProviderOptions | Configuration options for mock docker model provider. |
MockE2bModelProvider | value | typeof MockE2bModelProvider | A deterministic ModelProvider for E2B agent tests and init templates. Returns structured responses without requiring real API credentials. |
MockE2bModelProviderOptions | type | MockE2bModelProviderOptions | Configuration options for mock e2b model provider. |
MockK8sModelProvider | value | typeof MockK8sModelProvider | A deterministic ModelProvider for Kubernetes agent tests and init templates. Returns structured responses without requiring real API credentials. |
MockK8sModelProviderOptions | type | MockK8sModelProviderOptions | Configuration options for mock k8s model provider. |
MockModalModelProvider | value | typeof MockModalModelProvider | A deterministic ModelProvider for Modal agent tests and init templates. Returns structured responses without requiring real API credentials. |
MockModalModelProviderOptions | type | MockModalModelProviderOptions | Configuration options for mock modal model provider. |
MockNodeModelProvider | value | typeof MockNodeModelProvider | A deterministic ModelProvider for Node agent tests and init templates. Returns structured responses without requiring real API credentials. |
MockNodeModelProviderOptions | type | MockNodeModelProviderOptions | Configuration options for mock node model provider. |
modal | value | (config: ModalBundleConfig, isMock?: boolean) => ModalBundle | One-call wiring for a Modal-native agent: resolves the model provider from config or env, includes built-in tools, and sets a safe default egress policy. |
ModalBundle | type | ModalBundle | Type contract for modal bundle. |
ModalBundleConfig | type | ModalBundleConfig | Type contract for modal bundle config. |
mongodbPersistence | value | (options: MongoPersistenceOptions) => FabricPersistence | Full bundle over a MongoDB collection using _id + version compare-and-swap. |
MongoPersistenceClient | type | MongoPersistenceClient | Client implementation for mongo persistence. |
MongoPersistenceCollection | type | MongoPersistenceCollection | Type contract for mongo persistence collection. |
MongoPersistenceOptions | type | MongoPersistenceOptions | Configuration options for mongo persistence. |
mysqlPersistence | value | (options: MySqlPersistenceOptions) => FabricPersistence | Full bundle over a MySQL 8 compatible database using version-fenced snapshot rows. |
MySqlPersistenceClient | type | MySqlPersistenceClient | Client implementation for my sql persistence. |
MySqlPersistenceOptions | type | MySqlPersistenceOptions | Configuration options for my sql persistence. |
nextScheduledAt | value | (expression: string, currentDate?: Date, timezone?: string) => Date | Runtime API for next scheduled at; the generated signature shows its accepted inputs and return type. |
node | value | (config: NodeBundleConfig, isMock?: boolean) => NodeBundle | One-call wiring for a Node-native agent: resolves the model provider from config or env, includes built-in file/shell tools, and sets a safe default egress policy. |
NodeBundle | type | NodeBundle | Type contract for node bundle. |
NodeBundleConfig | type | NodeBundleConfig | Type contract for node bundle config. |
OidcClaimMapping | type | OidcClaimMapping | Type contract for oidc claim mapping. |
oidcJwtAuthenticator | value | (options: OidcJwtAuthenticatorOptions) => (request: IncomingMessage) => Promise<ServerPrincipal | false | undefined> | Validate Bearer JWTs with a local or remote JWKS and map claims into server RBAC. |
OidcJwtAuthenticatorOptions | type | OidcJwtAuthenticatorOptions | Configuration options for oidc jwt authenticator. |
OidcPrincipalContext | type | OidcPrincipalContext | Type contract for oidc principal context. |
parseCookie | value | (req: http.IncomingMessage, name: string) => string | undefined | Parse the Cookie header on an IncomingMessage and return a named cookie's value, or undefined when missing. Use inside a custom extractAuthToken to validate session cookies set by your existing identity layer. |
ParsedFabricResponsesRequest | type | ParsedFabricResponsesRequest | Input contract for parsed fabric responses. |
parseFabricResponsesRequest | value | (value: unknown) => ParsedFabricResponsesRequest | Parses fabric responses request. |
parseFrontmatter | value | (markdown: string) => FrontmatterResult | Parses frontmatter. |
pathExists | value | (filePath: string) => Promise<boolean> | Runtime API for path exists; the generated signature shows its accepted inputs and return type. |
PersistedCompactionResult | type | PersistedCompactionResult | Result returned by persisted compaction. |
PersistentDispatchProcessorOptions | type | PersistentDispatchProcessorOptions | Configuration options for persistent dispatch processor. |
PersistentPromptOptions | type | PersistentPromptOptions | Configuration options for persistent prompt. |
PersistentPromptResult | type | PersistentPromptResult | Result returned by persistent prompt. |
PersistentSessionBusyError | value | typeof PersistentSessionBusyError | Error raised for persistent session busy failures. |
PersistentSubmissionExecutorOptions | type | PersistentSubmissionExecutorOptions | Configuration options for persistent submission executor. |
PersistentTaskOptions | type | PersistentTaskOptions | Configuration options for persistent task. |
PersistentTaskResult | type | PersistentTaskResult | Result returned by persistent task. |
PostgresAttachmentStore | value | typeof PostgresAttachmentStore | Storage contract for postgres attachment. |
PostgresAttachmentStoreOptions | type | PostgresAttachmentStoreOptions | Configuration options for postgres attachment store. |
PostgresBackupRecord | type | PostgresBackupRecord | Type contract for postgres backup record. |
PostgresClientLike | type | PostgresClientLike | Type contract for postgres client like. |
PostgresConversationStreamStore | value | typeof PostgresConversationStreamStore | Storage contract for postgres conversation stream. |
PostgresConversationStreamStoreOptions | type | PostgresConversationStreamStoreOptions | Configuration options for postgres conversation stream store. |
postgresCostBudgetStore | value | (options: PostgresCostBudgetStoreOptions) => CostBudgetStore | Postgres-backed cost budget store. Pair with init({ costLimit: { perScope, scopeKey, store } }) to enforce a budget that survives process restarts — per-tenant, per-day, per-organization caps, etc. The table holds one row per scope key: (scope TEXT PRIMARY KEY, total_usd NUMERIC, updated_at TIMESTAMPTZ). Increments use ON CONFLICT UPDATE for atomic compare-and-set semantics. |
PostgresCostBudgetStoreOptions | type | PostgresCostBudgetStoreOptions | Configuration options for postgres cost budget store. |
postgresDeletionEvidenceStore | value | (client: PostgresClientLike, options?: { tablePrefix?: string; }) => DeletionEvidenceStore | Storage contract for postgres deletion evidence. |
PostgresMigration | type | PostgresMigration | Type contract for postgres migration. |
PostgresMigrationResult | type | PostgresMigrationResult | Result returned by postgres migration. |
postgresPersistence | value | (options: PostgresPersistenceOptions) => FabricPersistence | One Postgres/Lakebase bundle for every durable Node server store. |
PostgresPersistenceOptions | type | PostgresPersistenceOptions | Configuration options for postgres persistence. |
PostgresRestoreResult | type | PostgresRestoreResult | Result returned by postgres restore. |
postgresSandboxOwnershipLeaseStore | value | (client: SandboxOwnershipPostgresClient, options?: { tableName?: string; }) => SandboxOwnershipLeaseStore | Atomic, expiry-aware ownership leases for portable sandboxes. |
postgresSchedulerLeaseStore | value | (client: SchedulerPostgresClient, options?: { tableName?: string; }) => SchedulerLeaseStore | Postgres-backed scheduler leases for horizontally scaled Node deployments. |
postgresSessionMemory | value | (options: PostgresSessionMemoryOptions) => SessionMemory | Postgres-backed SessionMemory. Persistent across process restarts; scoped by tenantId. Pair with init({ memory }) to share recall across a fleet of agents. Schema: CREATE TABLE fabric_harness_session_memory ( tenant_id TEXT NOT NULL DEFAULT '', key TEXT NOT NULL, value JSONB NOT NULL, metadata JSONB, expires_at TIMESTAMPTZ, updated_at TIMESTAMPTZ NOT NULL DEFAULT NOW(), PRIMARY KEY (tenant_id, key) ); Set/Get scrub expired rows lazily on access. Run a scheduled DELETE WHERE expires_at < NOW() if you have many TTL'd entries. |
PostgresSessionMemoryOptions | type | PostgresSessionMemoryOptions | Configuration options for postgres session memory. |
PostgresSessionStore | value | typeof PostgresSessionStore | Storage contract for postgres session. |
PostgresSessionStoreOptions | type | PostgresSessionStoreOptions | Configuration options for postgres session store. |
PostgresSubmissionStore | value | typeof PostgresSubmissionStore | Storage contract for postgres submission. |
PostgresSubmissionStoreOptions | type | PostgresSubmissionStoreOptions | Configuration options for postgres submission store. |
principalHasPermission | value | (principal: ServerPrincipal, permission: ServerPermission) => boolean | Runtime API for principal has permission; the generated signature shows its accepted inputs and return type. |
principalToActor | value | (principal: ServerPrincipal) => FabricActor | Runtime API for principal to actor; the generated signature shows its accepted inputs and return type. |
principalToApprovalActor | value | (principal: ServerPrincipal) => ActorIdentity | Runtime API for principal to approval actor; the generated signature shows its accepted inputs and return type. |
PrivateNetworkFetchClient | type | PrivateNetworkFetchClient | Client implementation for private network fetch. |
PrivateNetworkFetchOptions | type | PrivateNetworkFetchOptions | Configuration options for private network fetch. |
PrivateNetworkProxyOptions | type | PrivateNetworkProxyOptions | Configuration options for private network proxy. |
PrivateNetworkTlsOptions | type | PrivateNetworkTlsOptions | Configuration options for private network tls. |
readBuildManifest | value | (workspaceRoot: string, target: string) => Promise<BuildManifest | undefined> | Runtime API for read build manifest; the generated signature shows its accepted inputs and return type. |
redisApprovalNotificationStore | value | (options: RedisApprovalNotificationStoreOptions) => ApprovalNotificationDeliveryStore | Distributed dedupe state for approvalNotificationHandler(). |
RedisApprovalNotificationStoreOptions | type | RedisApprovalNotificationStoreOptions | Configuration options for redis approval notification store. |
RedisClientLike | type | RedisClientLike | Cross-process token-bucket rate limiter backed by Redis. Pair with OpenAICompatibleModelProvider / AnthropicModelProvider to enforce a shared API-key quota across a fleet of containers. RedisClientLike only requires an eval method — both ioredis and @upstash/redis ship a compatible signature. fabric-harness does NOT depend on either; users pass their own client. |
redisHttpRateLimiter | value | (options: RedisHttpRateLimiterOptions) => HttpRateLimiter | Creates an atomic, cross-process HTTP limiter for startDevServer. The caller supplies its Redis client so the Node package has no Redis SDK dependency. |
RedisHttpRateLimiterOptions | type | RedisHttpRateLimiterOptions | Configuration options for redis http rate limiter. |
redisPersistence | value | (options: RedisPersistenceOptions) => FabricPersistence | Redis/Valkey bundle with cluster-safe keys, binary attachments, and optional retention TTL. |
RedisPersistenceClient | type | RedisPersistenceClient | Client implementation for redis persistence. |
RedisPersistenceOptions | type | RedisPersistenceOptions | Configuration options for redis persistence. |
redisRateLimiter | value | (options: RedisRateLimiterOptions) => RateLimiter | Runtime API for redis rate limiter; the generated signature shows its accepted inputs and return type. |
RedisRateLimiterOptions | type | RedisRateLimiterOptions | Configuration options for redis rate limiter. |
renderOperatorConsole | value | () => string | Runtime API for render operator console; the generated signature shows its accepted inputs and return type. |
renderResponsesInput | value | (input: string | FabricResponsesInputItem[]) => string | Runtime API for render responses input; the generated signature shows its accepted inputs and return type. |
ReplayInspection | type | ReplayInspection | Type contract for replay inspection. |
resolveAgentPath | value | (workspaceRoot: string, agent: string) => Promise<string> | Resolves agent path. |
resolveApprovalInStore | value | (store: SessionStore, sessionId: string, approvalId: string, decision: "approved" | "denied", reason?: string, actor?: ActorIdentity | string) => Promise<ApprovalSummary> | Resolves approval in store. |
resolveConfigPath | value | (workspaceRoot: string) => Promise<string | undefined> | Resolves config path. |
resolveDatabricksAppResourceBindings | value | (input: readonly FabricHarnessDatabricksAppResourceConfig[] | undefined, options?: ResolveDatabricksAppResourceBindingsOptions) => ResolvedDatabricksAppResourceBinding[] | Validate and normalize native Databricks App resource bindings without network access. |
ResolveDatabricksAppResourceBindingsOptions | type | ResolveDatabricksAppResourceBindingsOptions | Configuration options for resolve databricks app resource bindings. |
resolveDaytonaToolRefs | value | (bundle: DaytonaBundle, refs: string[]) => ToolDef[] | Resolves daytona tool refs. |
ResolvedDatabricksAppResourceBinding | type | ResolvedDatabricksAppResourceBinding | Type contract for resolved databricks app resource binding. |
ResolvedDatabricksAppResourceVariable | type | ResolvedDatabricksAppResourceVariable | Type contract for resolved databricks app resource variable. |
resolveDockerToolRefs | value | (bundle: DockerBundle, refs: string[]) => ToolDef[] | Resolves docker tool refs. |
resolveE2bToolRefs | value | (bundle: E2bBundle, refs: string[]) => ToolDef[] | Resolves e2b tool refs. |
resolveK8sToolRefs | value | (bundle: K8sBundle, refs: string[]) => ToolDef[] | Resolves k8s tool refs. |
resolveModalToolRefs | value | (bundle: ModalBundle, refs: string[]) => ToolDef[] | Resolves modal tool refs. |
resolvePrincipalTenant | value | (principal: ServerPrincipal, requestedTenantId: string | undefined) => { tenantId?: string; forbidden: boolean; } | Resolves principal tenant. |
resolveServerPermission | value | (method: string | undefined, path: string) => ServerPermission | Resolves server permission. |
resolveSessionApproval | value | (workspaceRoot: string, sessionId: string, approvalId: string, decision: "approved" | "denied", reason?: string, actor?: ActorIdentity | string) => Promise<ApprovalSummary> | Resolves session approval. |
resolveSseKeepaliveMs | value | (env?: NodeJS.ProcessEnv) => number | Resolve the SSE keepalive interval from the environment. Returns the parsed FABRIC_HARNESS_SSE_KEEPALIVE_MS value, or the 15000ms default. Negative or unparseable values fall back to the default. Returns 0 when explicitly set to 0, disabling keepalive. |
resolveToolRefs | value | (bundle: NodeBundle, refs: string[]) => ToolDef[] | Resolves tool refs. |
resolveWorkspacePackageImport | value | (workspaceRoot: string, packageName: string) => Promise<string | undefined> | Resolve an installed package's ESM entrypoint from the workspace dependency tree. |
responseIdForSubmission | value | (submissionId: string) => string | Runtime API for response id for submission; the generated signature shows its accepted inputs and return type. |
responseTraceIdForSubmission | value | (submissionId: string) => string | Matches the deterministic trace id emitted by the Databricks MLflow trace exporter. |
restorePostgresPersistence | value | (input: { client: PostgresClientLike; objectStore: BackupObjectStore; objectKey: string; tablePrefix?: string; }) => Promise<PostgresRestoreResult> | Verify and restore a logical backup under an exclusive advisory lock and transaction. |
RetentionResult | type | RetentionResult | Result returned by retention. |
RetentionRule | type | RetentionRule | Type contract for retention rule. |
runAgent | value | (options: RunAgentOptions) => Promise<RunAgentResult> | Runs agent. |
RunAgentOptions | type | RunAgentOptions | Configuration options for run agent. |
RunAgentResult | type | RunAgentResult | Result returned by run agent. |
runPersistentPrompt | value | (options: PersistentPromptOptions) => Promise<PersistentPromptResult> | Runs persistent prompt. |
runPersistentTask | value | (options: PersistentTaskOptions) => Promise<PersistentTaskResult> | Invoke a hook-registered persistent-agent specialist through the normal bounded task runtime. |
runPostgresRecoveryDrill | value | (input: { client: PostgresClientLike; objectStore: BackupObjectStore; objectKey: string; tablePrefix?: string; simulateFailure: () => Promise<void>; verify: () => Promise<void>; maxRtoMs?: number; maxRpoSeconds?: number; }) => Promise<{ b... | Runs postgres recovery drill. |
SandboxOwnershipPostgresClient | type | SandboxOwnershipPostgresClient | Client implementation for sandbox ownership postgres. |
SchedulerLeaseStore | type | SchedulerLeaseStore | Storage contract for scheduler lease. |
SchedulerPostgresClient | type | SchedulerPostgresClient | Client implementation for scheduler postgres. |
ServerAuthorizationContext | type | ServerAuthorizationContext | Type contract for server authorization context. |
ServerPermission | type | ServerPermission | Type contract for server permission. |
ServerPrincipal | type | ServerPrincipal | Type contract for server principal. |
SessionMetrics | type | SessionMetrics | Type contract for session metrics. |
sessionRunStore | value | (store: SessionStore) => RunStore | Storage contract for session run. |
SessionSummary | type | SessionSummary | Type contract for session summary. |
SessionTimeline | type | SessionTimeline | Type contract for session timeline. |
SqliteAttachmentStore | value | typeof SqliteAttachmentStore | Storage contract for sqlite attachment. |
SqliteAttachmentStoreOptions | type | SqliteAttachmentStoreOptions | Configuration options for sqlite attachment store. |
SqliteConversationStreamStore | value | typeof SqliteConversationStreamStore | Storage contract for sqlite conversation stream. |
SqliteConversationStreamStoreOptions | type | SqliteConversationStreamStoreOptions | Configuration options for sqlite conversation stream store. |
SqliteCostBudgetStore | value | typeof SqliteCostBudgetStore | Atomic cross-process cost totals for a single-node SQLite deployment. |
SqliteCostBudgetStoreOptions | type | SqliteCostBudgetStoreOptions | Configuration options for sqlite cost budget store. |
SqliteDatabaseLike | type | SqliteDatabaseLike | The slice of node:sqlite's DatabaseSync this store uses. |
sqlitePersistence | value | (options: SqlitePersistenceOptions) => FabricPersistence | Unified durable bundle for local and single-node deployments. |
SqlitePersistenceOptions | type | SqlitePersistenceOptions | Configuration options for sqlite persistence. |
SQLiteSessionStore | value | typeof SQLiteSessionStore | Storage contract for sqlite session. |
SQLiteSessionStoreOptions | type | SQLiteSessionStoreOptions | Configuration options for sqlite session store. |
SqliteSubmissionStore | value | typeof SqliteSubmissionStore | Storage contract for sqlite submission. |
SqliteSubmissionStoreOptions | type | SqliteSubmissionStoreOptions | Configuration options for sqlite submission store. |
SSE_KEEPALIVE_DEFAULT_MS | value | 15000 | Constant defining sse keepalive default ms. |
startDevServer | value | (options?: DevServerOptions) => Promise<DevServerHandle> | Runtime API for start dev server; the generated signature shows its accepted inputs and return type. |
startJobScheduler | value | (options: JobSchedulerOptions) => Promise<JobScheduler> | Start an in-process cron scheduler for finite job triggers.schedule values. |
submissionIdFromResponseId | value | (responseId: string) => string | undefined | Runtime API for submission id from response id; the generated signature shows its accepted inputs and return type. |
TaskStatus | type | TaskStatus | Type contract for task status. |
TaskSummary | type | TaskSummary | Type contract for task summary. |
TimelineItem | type | TimelineItem | Type contract for timeline item. |
transpileAgent | value | (options: TranspileAgentOptions) => Promise<string> | Runtime API for transpile agent; the generated signature shows its accepted inputs and return type. |
TranspileAgentOptions | type | TranspileAgentOptions | Configuration options for transpile agent. |
vaultSecretProvider | value | (options: VaultSecretProviderOptions) => SecretProvider | HashiCorp Vault KV v2 provider. Vault tokens remain in the adapter closure. |
VaultSecretProviderOptions | type | VaultSecretProviderOptions | Configuration options for vault secret provider. |
verifyAttestation | value | (pathOrDir: string) => Promise<{ ok: true; manifestPath: string; attestationPath: string; manifestSha256: string; }> | Runtime API for verify attestation; the generated signature shows its accepted inputs and return type. |
verifyProvenance | value | (pathOrDir: string) => Promise<{ ok: true; manifestPath: string; provenancePath: string; manifestSha256: string; }> | Runtime API for verify provenance; the generated signature shows its accepted inputs and return type. |
withDeletionEvidence | value | (persistence: PersistenceBundle, options: { signer: DeletionEvidenceSigner; store: DeletionEvidenceStore; }) => PersistenceBundle | Add signed, append-only deletion evidence to any persistence bundle. |
withPostgresConnection | value | <T>(client: PostgresClientLike, operation: (connection: PostgresClientLike) => Promise<T>) => Promise<T> | Runtime API for with postgres connection; the generated signature shows its accepted inputs and return type. |
WorkspaceInfo | type | WorkspaceInfo | Type contract for workspace info. |
@fabric-harness/node/agent
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
defineNodeAgent | value | (options?: DefineNodeAgentOptions) => DefinedAgent<JsonObject, unknown> | Defines node agent. |
DefineNodeAgentOptions | type | DefineNodeAgentOptions | Configuration options for define node agent. |
node | value | (config: NodeBundleConfig, isMock?: boolean) => NodeBundle | One-call wiring for a Node-native agent: resolves the model provider from config or env, includes built-in file/shell tools, and sets a safe default egress policy. |
NodeBundle | type | NodeBundle | Type contract for node bundle. |
NodeBundleConfig | type | NodeBundleConfig | Type contract for node bundle config. |
resolveToolRefs | value | (bundle: NodeBundle, refs: string[]) => ToolDef[] | Resolves tool refs. |
@fabric-harness/node/docker-agent
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
defineDockerAgent | value | (options?: DefineDockerAgentOptions) => DefinedAgent<JsonObject, unknown> | Defines docker agent. |
DefineDockerAgentOptions | type | DefineDockerAgentOptions | Configuration options for define docker agent. |
docker | value | (config: DockerBundleConfig, isMock?: boolean) => DockerBundle | One-call wiring for a Docker-native agent: resolves the model provider from config or env, includes Docker-specific container tools, and sets a safe default egress policy. |
DockerBundle | type | DockerBundle | Type contract for docker bundle. |
DockerBundleConfig | type | DockerBundleConfig | Type contract for docker bundle config. |
resolveDockerToolRefs | value | (bundle: DockerBundle, refs: string[]) => ToolDef[] | Resolves docker tool refs. |
@fabric-harness/node/k8s-agent
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
defineK8sAgent | value | (options?: DefineK8sAgentOptions) => DefinedAgent<JsonObject, unknown> | Defines k8s agent. |
DefineK8sAgentOptions | type | DefineK8sAgentOptions | Configuration options for define k8s agent. |
k8s | value | (config: K8sBundleConfig, isMock?: boolean) => K8sBundle | One-call wiring for a Kubernetes-native agent: resolves the model provider from config or env, includes K8s-specific kubectl tools, and sets a safe default egress policy. |
K8sBundle | type | K8sBundle | Type contract for k8s bundle. |
K8sBundleConfig | type | K8sBundleConfig | Type contract for k8s bundle config. |
resolveK8sToolRefs | value | (bundle: K8sBundle, refs: string[]) => ToolDef[] | Resolves k8s tool refs. |
@fabric-harness/sdk
@fabric-harness/sdk
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
actionAsTool | value | <TInput, TOutput>(action: ActionDefinition<TInput, TOutput>, host: ActionHost) => ToolDef<unknown, TOutput> | Expose an action to the model as a tool on an agent profile. The tool's JSON schema comes from the action's input schema; execution validates input/output exactly like runAction. |
ActionContext | type | ActionContext<TInput> | Context passed to an action's run. Unlike a tool's execute (a leaf capability invoked by the model), an action receives the harness itself and can orchestrate: prompt models, spawn sessions, call other actions. |
ActionDefinition | type | ActionDefinition<TInput, TOutput> | A named, schema-validated unit of harness work created with defineAction. First-class in v2: registrable on agent profiles as a tool, callable from jobs and agents, evaluable via fh test, and deployable as a platform job task. |
ActionError | value | typeof ActionError | Error raised for action failures. |
ActionHost | type | ActionHost | What an action runs against: the harness entry point (init can prompt models, spawn sessions, and call tools) plus the platform environment. Jobs, agents, and servers all satisfy this — it is the harness slice of FabricContext. |
ActionOptions | type | ActionOptions<TInput, TOutput> | Configuration options for action. |
ActivateSkillInput | type | ActivateSkillInput | Type contract for activate skill input. |
ActorIdentity | type | ActorIdentity | Type contract for actor identity. |
ActualCostSource | type | ActualCostSource | External source for actual (non-estimated) spend. Implementations can query provider billing APIs, Databricks usage tables, or other real-time cost data. |
admitSubmissionWithBackend | value | <Row extends SubmissionAdmissionRow>(input: AgentSubmissionInput, backend: SubmissionAdmissionBackend<Row>) => AgentDispatchAdmission | Promise<AgentDispatchAdmission> | Shared submission admission algorithm for row-oriented backends: dispatch-receipt check → insert-or-ignore → read-back → payload compare (idempotent replay vs. conflict). The message payload is stored as JSON verbatim; payload identity is deep JSON equality, so a backend that normalizes stored JSON (e.g. Postgres JSONB key ordering) still recognizes an exact replay. The caller owns transaction scoping — invoke this inside one transaction and pass callbacks bound to it. When every callback is synchronous the result is returned synchronously, so the algorithm also fits synchronous backends. |
AgentAttemptMarker | type | AgentAttemptMarker | Harness-owned durable evidence that a submission attempt was started and has not yet settled. A coordinator inserts a marker immediately before starting an attempt and deletes it when the attempt settles; reconciliation treats a fresh marker as proof that the attempt may still be running and must not be reconciled as interrupted. |
AgentDefinition | type | AgentDefinition<TInput, TOutput> | Type contract for agent definition. |
AgentDispatchAdmission | type | AgentDispatchAdmission | Type contract for agent dispatch admission. |
AgentDispatchReceipt | type | AgentDispatchReceipt | Type contract for agent dispatch receipt. |
AgentDispatchRequest | type | AgentDispatchRequest | Async delivery request to a persistent agent instance + session. |
AgentEvent | type | AgentEvent | Type contract for agent event. |
AgentEventBase | type | AgentEventBase | Common envelope shared by every event variant. |
AgentEventCallback | type | AgentEventCallback | Callback signature accepted by init({ onEvent }), agent.session(id, { onEvent }), and session.prompt(text, { onEvent }). |
AgentEventType | type | "agent_start" | "session_start" | "prompt_start" | "prompt_end" | "turn_start" | "turn_end" | "model_attempt" | "text_delta" | "toolcall_delta" | "submission_queued" | "submission_running" | "submission_recovery" | "submission_settled" | "cost_limit" | "webhook_r... | Type contract for agent event type. |
AgentInit | type | AgentInit | Type contract for agent init. |
AgentLoopRuntime | type | AgentLoopRuntime | Type contract for agent loop runtime. |
AgentMiddleware | type | (context: AgentRunContext<TInput>, next: () => Promise<TOutput>) => Promise<TOutput> | TOutput | Middleware for agent. |
AgentProfile | type | AgentProfile | Type contract for agent profile. |
AgentProfileOptions | type | AgentProfileOptions | Configuration options for agent profile. |
AgentRunContext | type | AgentRunContext<TInput> | Runtime-ready context for finite agents. The default session is initialized lazily. |
AgentSubmission | type | AgentSubmission | Type contract for agent submission. |
AgentSubmissionDurability | type | AgentSubmissionDurability | Type contract for agent submission durability. |
AgentSubmissionInput | type | AgentSubmissionInput | One admitted agent submission — the persisted operational payload for both transports. kind records how the submission arrived ('dispatch' via dispatch(), 'direct' via the agent HTTP route); a dispatch's submissionId is the public dispatchId from its receipt. |
AgentSubmissionStatus | type | AgentSubmissionStatus | Type contract for agent submission status. |
AgentSubmissionStore | type | AgentSubmissionStore | Durable submission lifecycle storage. Stability: the lease method group mirrors the durable-execution engine and is subject to change until 1.0. This applies to every backend equally. |
AgentTriggers | type | AgentTriggers | Type contract for agent triggers. |
aiGateway | value | (options: AIGatewayOptions) => OpenAICompatibleModelProvider | Generic OpenAI-compatible AI gateway helper. Use for any gateway that speaks the OpenAI Chat Completions request/response shape: Helicone, Portkey, LiteLLM (self-hosted), Cloudflare AI Gateway, internal corp proxies, etc. See the package declarations for an example. For Vercel AI Gateway, prefer the vercelAIGateway preset — same factory under the hood with the gateway URL pre-baked. |
AIGatewayOptions | type | AIGatewayOptions | Configuration options for aigateway. |
AnthropicModelProvider | value | typeof AnthropicModelProvider | Provider implementation for anthropic model. |
AnthropicProviderOptions | type | AnthropicProviderOptions | Configuration options for anthropic provider. |
applyEstimatedCost | value | <T extends { costUsd?: number; } | undefined>(modelRef: string | undefined, usage: T) => T | Idempotently populate usage.costUsd from the static price table. Mutates usage and returns it. No-op when: - usage is undefined, - usage.costUsd is already set (provider supplied it directly), - no price row matches modelRef. |
ApprovalCallback | type | ApprovalCallback | Type contract for approval callback. |
ApprovalDecision | type | ApprovalDecision | Type contract for approval decision. |
ApprovalGrant | type | ApprovalGrant | Durable provenance for one approved logical tool operation. A grant may be replayed for the same logical operation after a crash, but must never authorize a different tool call, input, or executing principal. |
approvalGrantFromJson | value | (value: unknown) => ApprovalGrant | undefined | Parse persisted provenance without trusting a partial or malformed object. |
approvalGrantToJson | value | (grant: ApprovalGrant) => JsonObject | Runtime API for approval grant to json; the generated signature shows its accepted inputs and return type. |
approvalInputDigest | value | (input: unknown) => string | Deterministic digest shared by inline and durable approval runtimes. |
ApprovalNotification | type | ApprovalNotification | Type contract for approval notification. |
ApprovalNotificationDeadLetter | type | ApprovalNotificationDeadLetter | Type contract for approval notification dead letter. |
ApprovalNotificationDeliveryStore | type | ApprovalNotificationDeliveryStore | Storage contract for approval notification delivery. |
approvalNotificationFromEvent | value | (event: FabricEvent, baseUrl?: string) => ApprovalNotification | undefined | Runtime API for approval notification from event; the generated signature shows its accepted inputs and return type. |
approvalNotificationHandler | value | (options: ApprovalNotificationHandlerOptions) => FabricEventCallback | Convert approval events into retryable, deduplicated notifications. This callback never throws. |
ApprovalNotificationHandlerOptions | type | ApprovalNotificationHandlerOptions | Configuration options for approval notification handler. |
ApprovalNotificationState | type | ApprovalNotificationState | Type contract for approval notification state. |
ApprovalNotifier | type | ApprovalNotifier | Type contract for approval notifier. |
ApprovalOptions | type | ApprovalOptions | Configuration options for approval. |
ApprovalPolicyRule | type | ApprovalPolicyRule | Per-pattern approval metadata. Lets policy authors route specific tools/commands to a named audience (e.g. 'reviewer', 'compliance-team', 'project-admin'). The audience id is opaque to fabric-harness — host applications map ids to humans via their own identity layer. |
ApprovalRequest | type | ApprovalRequest | Input contract for approval. |
ApprovalResponse | type | ApprovalResponse | Response contract for approval. |
ApprovalRisk | type | ApprovalRisk | Type contract for approval risk. |
ApprovalState | type | ApprovalState | Type contract for approval state. |
approvalStatesFromEntries | value | (sessionId: string, entries: SessionEntry[]) => ApprovalState[] | Runtime API for approval states from entries; the generated signature shows its accepted inputs and return type. |
ApprovalStateStatus | type | ApprovalStateStatus | Type contract for approval state status. |
ApprovalUnavailableStrategy | type | ApprovalUnavailableStrategy | Type contract for approval unavailable strategy. |
ApprovalVote | type | ApprovalVote | Type contract for approval vote. |
ArtifactCreateOptions | type | ArtifactCreateOptions | Configuration options for artifact create. |
ArtifactRef | type | ArtifactRef | Type contract for artifact ref. |
assertEnforceableNetworkPolicy | value | (policy: CapabilityPolicy | undefined, sandbox: SandboxEnv | Pick<SandboxCapabilities, "network" | "networkEnforcement" | "networkBoundary"> | undefined, requirement?: NetworkEnforcementRequirement) => void | Refuse production network policy when it can be bypassed by code in the sandbox. This validates an operator assertion; the named network boundary must still be provisioned by Docker, Kubernetes, or the cloud provider. |
attachmentDigest | value | (bytes: Uint8Array) => Promise<string> | Lowercase hex SHA-256 of the bytes (WebCrypto). |
AttachmentLimitError | value | typeof AttachmentLimitError | Error raised for attachment limit failures. |
AttachmentPutInput | type | AttachmentPutInput | Type contract for attachment put input. |
AttachmentRef | type | AttachmentRef | Content-addressed descriptor of one stored attachment. |
AttachmentStore | type | AttachmentStore | Durable content-addressed attachment storage. - put is idempotent by (scope, digest) — re-putting the same content succeeds without duplicating storage (the first stored ref metadata is retained). It MUST verify the digest against the bytes and reject a mismatch with AttachmentStoreError('DIGEST_MISMATCH') before writing. - get/getByAttachmentId return null on a miss. - delete removes one stored attachment and throws AttachmentStoreError('NOT_FOUND') when nothing is stored under (scope, digest). |
AttachmentStoreError | value | typeof AttachmentStoreError | Error raised for attachment store failures. |
attachSandbox | value | (ref: SandboxRef | SerializedSandboxRef, options?: AttachSandboxOptions) => SandboxFactory | Build a SandboxFactory that, when invoked, returns an AttachedSandboxEnv delegating to the registered sandbox without owning its lifecycle. Calling cleanup() on the attached env unregisters this attachment but does NOT tear down the underlying sandbox. Pass an in-process SandboxRef to attach within the same process, or a SerializedSandboxRef (from session.sandboxRef({ portable: true })) to rehydrate a sandbox handed off from another process. Cross-process refs require a decoder registered for serialized.provider via registerSandboxRefDecoder(). |
AttachSandboxOptions | type | AttachSandboxOptions | Configuration options for attach sandbox. |
AttributionQuery | type | AttributionQuery | Query filters for retrieving aggregated cost attribution rows. |
AutonomyMode | type | AutonomyMode | Type contract for autonomy mode. |
AutonomyOptions | type | AutonomyOptions | Configuration options for autonomy. |
AzureOpenAIModelProvider | value | typeof AzureOpenAIModelProvider | Provider implementation for azure open aimodel. |
AzureOpenAIProviderOptions | type | AzureOpenAIProviderOptions | Configuration options for azure open aiprovider. |
BashInput | type | BashInput | Type contract for bash input. |
bashTool | value | (sandbox?: SandboxEnv) => ToolDef<BashInput, ShellResult> | Model-callable tool or tool factory for bash. |
BedrockModelProvider | value | typeof BedrockModelProvider | Provider implementation for bedrock model. |
BedrockProviderOptions | type | BedrockProviderOptions | Configuration options for bedrock provider. |
buildModelMessagesFromHistory | value | (data: SessionData | undefined, role?: Role) => ModelMessage[] | Runtime API for build model messages from history; the generated signature shows its accepted inputs and return type. |
buildResultFollowUpPrompt | value | () => string | Follow-up prompt sent when the LLM ends a turn without calling finish or give_up. |
buildResultFooter | value | () => string | Footer appended to user prompts/skill bodies when a result schema is set. |
buildResultRetryPrompt | value | (error: unknown, extraction?: boolean | ResultExtractionOptions) => string | Runtime API for build result retry prompt; the generated signature shows its accepted inputs and return type. |
BUILTIN_BASH_MAX_BYTES | value | number | Constant defining builtin bash max bytes. |
BUILTIN_BASH_MAX_LINES | value | 2000 | Constant defining builtin bash max lines. |
BUILTIN_GLOB_MAX_RESULTS | value | 1000 | Constant defining builtin glob max results. |
BUILTIN_GREP_MAX_LINE_LENGTH | value | 500 | Constant defining builtin grep max line length. |
BUILTIN_GREP_MAX_MATCHES | value | 100 | Constant defining builtin grep max matches. |
BUILTIN_READ_MAX_BYTES | value | number | Constant defining builtin read max bytes. |
BUILTIN_READ_MAX_LINES | value | 2000 | Public built-in tool limits; documentation and tests consume these constants. |
BuiltinFileTool | type | BuiltinFileTool | Model-callable tool or tool factory for builtin file. |
BuiltinTool | type | BuiltinTool | Model-callable tool or tool factory for builtin. |
bytesToHex | value | (bytes: Uint8Array) => string | Runtime API for bytes to hex; the generated signature shows its accepted inputs and return type. |
CapabilityPolicy | type | CapabilityPolicy | Type contract for capability policy. |
CartesiaSttProvider | value | typeof CartesiaSttProvider | Provider implementation for cartesia stt. |
CartesiaSttProviderOptions | type | CartesiaSttProviderOptions | Configuration options for cartesia stt provider. |
CartesiaTtsProvider | value | typeof CartesiaTtsProvider | Provider implementation for cartesia tts. |
CartesiaTtsProviderOptions | type | CartesiaTtsProviderOptions | Configuration options for cartesia tts provider. |
chainSecretProviders | value | (...providers: Array<SecretProvider | undefined>) => SecretProvider | Resolve from providers in order; errors fail closed instead of falling through. |
Channel | type | Channel | Type contract for channel. |
ChannelContext | type | ChannelContext | Type contract for channel context. |
ChannelDispatch | type | ChannelDispatch | Type contract for channel dispatch. |
ChannelDispatchRequest | type | ChannelDispatchRequest | Input contract for channel dispatch. |
ChannelRoute | type | ChannelRoute | Channels turn platform webhooks (Slack, GitHub, …) into agent dispatches. Handlers are written against the Web Request/Response API and crypto.subtle, so the same channel runs on Node and Cloudflare. A channel is a stateless route container plus a conversation-id (de)serializer — session continuity falls out of the key (same thread → same key → same session). |
CheckpointCreateOptions | type | CheckpointCreateOptions | Configuration options for checkpoint create. |
CheckpointRestoreOptions | type | CheckpointRestoreOptions | Configuration options for checkpoint restore. |
CheckpointResult | type | CheckpointResult | Result returned by checkpoint. |
claimSandboxOwnership | value | (ref: SerializedSandboxRef, env: SandboxEnv, options: SandboxOwnershipOptions) => Promise<SandboxEnv> | Claim exclusive ownership of an already-connected portable sandbox. |
clampCommandTimeout | value | (timeout: number | undefined, policy?: CapabilityPolicy) => number | undefined | Runtime API for clamp command timeout; the generated signature shows its accepted inputs and return type. |
clampReadLimit | value | (limit: number | undefined) => number | Runtime API for clamp read limit; the generated signature shows its accepted inputs and return type. |
classifySubmissionState | value | (path: readonly SessionEntry[], submissionId: string) => SubmissionInspection | Classify how far a persisted submission input progressed. - absent — the input entry never landed in session history: the attempt crashed before applying it. Safe to requeue for a clean first attempt. - completed — finished work: a canonical settlement entry exists, an assistant response follows the input with no unresolved trailing tool batch, or a later user input shows the conversation moved on. Settle as success; never retry (retrying completed work is the one unrecoverable corruption). - continuable — the trailing turn carries unresolved tool calls. The next session.prompt() re... |
CohereModelProvider | value | typeof CohereModelProvider | Provider implementation for cohere model. |
CohereProviderOptions | type | CohereProviderOptions | Configuration options for cohere provider. |
combineSubmissionTelemetrySinks | value | (...sinks: SubmissionTelemetrySink[]) => SubmissionTelemetrySink | Fan one event out to several sinks. |
Command | type | Command<TInput> | Type contract for command. |
CommandEnvValue | type | CommandEnvValue | Type contract for command env value. |
CommandPolicy | type | CommandPolicy | Type contract for command policy. |
CommandToolInput | type | CommandToolInput | Type contract for command tool input. |
CommandToolOptions | type | CommandToolOptions | Configuration options for command tool. |
CompactionOptions | type | CompactionOptions | Configuration options for compaction. |
CompactionResult | type | CompactionResult | Result returned by compaction. |
configureDispatchRuntime | value | (runtime: DispatchRuntime) => void | Configure the ambient dispatch queue used by dispatch. |
configureJobInvocationRuntime | value | (next: JobInvocationRuntime) => void | Runtime API for configure job invocation runtime; the generated signature shows its accepted inputs and return type. |
connectFabricVoice | value | (options: VoiceWsClientOptions) => VoiceWsClientHandle | Runtime API for connect fabric voice; the generated signature shows its accepted inputs and return type. |
connectFabricWs | value | (options: WsClientOptions) => WsClientHandle | Runtime API for connect fabric ws; the generated signature shows its accepted inputs and return type. |
connectMcpServer | value | (name: string, options: McpServerOptions) => Promise<McpServerConnection> | Runtime API for connect mcp server; the generated signature shows its accepted inputs and return type. |
consoleTelemetryExporter | value | (prefix?: string) => TelemetryExporter | Telemetry exporter that writes spans through the SDK logger (default console-backed). Useful for local development and as a fallback when no OpenTelemetry collector is wired up. Use openTelemetryExporter or langfuseExporter for production. |
ContextBudget | type | ContextBudget | Type contract for context budget. |
ContextBudgetOptions | type | ContextBudgetOptions | Configuration options for context budget. |
CONVERSATION_STREAM_DEFAULT_READ_LIMIT | value | 100 | Constant defining conversation stream default read limit. |
CONVERSATION_STREAM_FORMAT_VERSION | value | 1 | Constant defining conversation stream format version. |
CONVERSATION_STREAM_MAX_READ_LIMIT | value | 1000 | Constant defining conversation stream max read limit. |
ConversationFoldCheckpoint | type | ConversationFoldCheckpoint | Disposable durable cache of a folded conversation at one committed batch. |
conversationKey | value | (provider: string, version: string, ...segments: string[]) => string | Runtime API for conversation key; the generated signature shows its accepted inputs and return type. |
ConversationMessage | type | ConversationMessage | Type contract for conversation message. |
ConversationMessageDisplay | type | ConversationMessageDisplay | Type contract for conversation message display. |
ConversationMessagePurpose | type | ConversationMessagePurpose | Type contract for conversation message purpose. |
ConversationMessageRole | type | ConversationMessageRole | Type contract for conversation message role. |
ConversationPart | type | ConversationPart | Type contract for conversation part. |
ConversationProducerClaim | type | ConversationProducerClaim | Type contract for conversation producer claim. |
ConversationProjector | value | typeof ConversationProjector | Runtime API for conversation projector; the generated signature shows its accepted inputs and return type. |
ConversationReply | type | ConversationReply | Type contract for conversation reply. |
ConversationSettlement | type | ConversationSettlement | Type contract for conversation settlement. |
ConversationSnapshot | type | ConversationSnapshot | Type contract for conversation snapshot. |
ConversationStreamAppendInput | type | ConversationStreamAppendInput | Type contract for conversation stream append input. |
ConversationStreamBatch | type | ConversationStreamBatch | Type contract for conversation stream batch. |
ConversationStreamIdentity | type | ConversationStreamIdentity | Type contract for conversation stream identity. |
ConversationStreamMeta | type | ConversationStreamMeta | Type contract for conversation stream meta. |
conversationStreamPath | value | (storeSessionId: string) => string | Stream path for a session's conversation projection. |
ConversationStreamReadResult | type | ConversationStreamReadResult | Result returned by conversation stream read. |
ConversationStreamRecord | type | ConversationStreamRecord | Append-only conversation stream — the durable, offset-addressable projection of a session's active path (v2 migration, phase A4). The SessionEntry DAG remains the single source of truth for model context; this stream exists so clients can read a conversation with offsets (catch-up + live tail), across processes, without count-based replay. The projection appends one record per active-path entry, and — because the DAG can branch (fork/replay/checkpoint-restore) while a stream cannot — an explicit truncated record whenever the active path rewinds, paired with a producer-epoch bump so stale... |
ConversationStreamStore | type | ConversationStreamStore | Durable append-only conversation stream storage. Batch atomicity is a hard contract requirement: every record in an append must be persisted together under one offset, all-or-nothing. First-party adapters satisfy this by serializing the batch into a single row/document write; an adapter that splits records across non-atomic writes violates the contract. Producer fencing: acquireProducer bumps the producer epoch; appends carrying a stale epoch are rejected. The (path, producerId, epoch, sequence) uniqueness makes redelivered appends idempotent — a retried append with the same coo... |
ConversationStreamStoreError | value | typeof ConversationStreamStoreError | Error raised for conversation stream store failures. |
CostAttribution | type | CostAttribution | Attribution dimensions for a single cost observation. All fields are optional so callers can tag as much or as little metadata as they have. |
CostAttributionRow | type | CostAttributionRow | A single row of aggregated cost attribution data. |
CostBudgetStore | type | CostBudgetStore | Async store for cross-process spend aggregation. Pair with CostLimit.scopeKey + CostLimit.perScope to enforce a budget that survives process restarts — "tenant:acme spends ≤ $50 today" or "company-wide ≤ $100 this hour". Built-in implementations: - inMemoryCostBudgetStore() — process-local; default. - @fabric-harness/node exposes postgresCostBudgetStore({ pool }). |
CostBudgetTracker | value | typeof CostBudgetTracker | Tracks cumulative session spend. Cheap to construct; one per session. |
CostLimit | type | CostLimit | Type contract for cost limit. |
CostLimitContext | type | CostLimitContext | Type contract for cost limit context. |
CostLimitExceededError | value | typeof CostLimitExceededError | Error raised for cost limit exceeded failures. |
createActivateSkillTool | value | (skillNames: string[], activate: (name: string) => Promise<string>) => ToolDef<ActivateSkillInput, string> | Creates activate skill tool. |
createAgent | value | <TEnv = Record<string, string>>(initialize: ((context: PersistentAgentContext<TEnv>) => PersistentAgentConfig | Promise<PersistentAgentConfig>) | DynamicAgentFunction<TEnv>, definition?: PersistentAgentConfig) => CreatedAgent<TEnv> | Define a persistent, URL-addressable agent. Files in .fabricharness/agents/ default-export createAgent(...); the runtime resolves a fresh config per interaction and keeps sessions across direct prompts and dispatched inputs. |
createApprovalGrant | value | (input: { approvalId: string; toolCallId: string; toolInput: unknown; principal: FabricPrincipal; response: ApprovalResponse; createdAt: string; ttlSeconds?: number; decidedAt?: string; }) => ApprovalGrant | Creates approval grant. |
createApprovalGrantForState | value | (state: ApprovalState, response: ApprovalResponse) => ApprovalGrant | undefined | Build the terminal grant after a store reaches approval quorum. |
createAttachmentRef | value | (input: { id: string; mimeType: string; bytes: Uint8Array; filename?: string; }) => Promise<AttachmentRef> | Build an AttachmentRef for the given bytes, computing the SHA-256 digest via WebCrypto (crypto.subtle) so the SDK stays runtime-agnostic. |
createBuiltinTools | value | (sandbox: SandboxEnv, packagedSkills?: Record<string, PackagedSkillDirectory>) => BuiltinTool[] | Creates builtin tools. |
createCommandTools | value | (commands: Command[], options?: CommandToolOptions) => ToolDef<CommandToolInput, ShellResult>[] | Creates command tools. |
createConsoleLogger | value | (level?: LogLevel) => Logger | Build a Console-backed logger with an explicit level. Useful for tests that want to capture or silence SDK output without touching globals. |
CreatedAgent | type | CreatedAgent<TEnv> | A persistent, addressable agent created with createAgent. Distinct from a finite defineAgent({ run }) job: it has no run — the initializer returns configuration, and the runtime maintains sessions across interactions. |
createDirectAgentSubmissionInput | value | (options: { agent: string; id: string; session?: string; message: DeliveredMessage; initialData?: JsonValue; uid?: string | null; joinWhileBusy?: boolean; tenantId?: string; actor?: FabricActor; durability?: AgentSubmissionDurability; }) => AgentSubmissionInput | Mint a direct-prompt submission input with a fresh submission id. |
createDispatchAgentSubmissionInput | value | (dispatch: DispatchInput) => AgentSubmissionInput | Map a DispatchInput onto the persisted submission input shape. |
createErrorReference | value | (now?: number) => string | Mint an opaque, sortable correlation reference for one transported error. |
createFabricContext | value | <TPayload extends JsonObject = JsonObject>(payload: TPayload) => FabricContext<TPayload> | Creates fabric context. |
createFabricFs | value | (sandboxLike: SandboxEnv | Promise<SandboxEnv> | (() => SandboxEnv | Promise<SandboxEnv>)) => FabricFs | Adapt a sandbox into the public filesystem convenience surface. |
createFileTools | value | (sandbox: SandboxEnv, packagedSkills?: Record<string, PackagedSkillDirectory>) => BuiltinFileTool[] | Creates file tools. |
createMcpAuthorizationCodeAuth | value | (options: McpAuthorizationCodeOptions) => OAuthClientProvider | Authorization-code + PKCE provider; the MCP SDK refreshes stored tokens automatically. |
createMcpClientCredentialsAuth | value | (options: McpClientCredentialsOptions) => OAuthClientProvider | OAuth client-credentials provider with MCP SDK token refresh handling. |
createMcpTools | value | (client: McpClientLike, options?: CreateMcpToolsOptions) => Promise<ToolDef[]> | Creates mcp tools. |
CreateMcpToolsOptions | type | CreateMcpToolsOptions | Configuration options for create mcp tools. |
createObservabilityObserver | value | (options: ObservabilityObserverOptions) => FabricEventCallback | Create a fail-open event observer suitable for Braintrust, Sentry, Jetty, or a custom sink. |
createObservabilityRecord | value | (event: FabricEvent, options: Pick<ObservabilityObserverOptions, "integration" | "correlation" | "captureData" | "additionalSecrets">) => FabricObservabilityRecord | Convert a Fabric event into a vendor-neutral, low-cardinality record. |
createOperationalMetricsCollector | value | () => OperationalMetricsCollector | Low-cardinality operational metrics collector suitable for OTel/Prometheus bridging. |
createRemoteSandboxEnv | value | (api: RemoteSandboxApi, options?: RemoteSandboxOptions) => SandboxEnv | Wrap a provider-owned remote sandbox client in Fabric's SandboxEnv contract. Provider credentials and SDK objects remain outside model context/history; Fabric only sees the narrow file/shell/snapshot API exposed here. |
createResultTools | value | <TResult>(validator: ResultValidator<TResult>) => ResultToolBundle<TResult> | Produce the per-call finish and give_up tool pair for a given ResultValidator. - finish's parameters are a generic JSON Schema object because we can't derive a precise schema from ResultValidator. The validator's safeParse handles actual validation. - First successful finish (or give_up) call wins. Subsequent calls return an error tool result rather than throwing, to keep the conversation transcript natural. |
createSandboxEnv | value | (options?: SandboxFactoryOptions) => Promise<SandboxEnv> | Creates sandbox env. |
createScopedSandboxEnv | value | (sandbox: SandboxEnv, cwd?: string) => SandboxEnv | Return a view of a sandbox with a narrower default cwd. Relative file paths and shell cwd values are resolved from this scoped cwd while the underlying sandbox still enforces its workspace boundary. |
createSearchTool | value | (retriever: Retriever, options?: SearchToolOptions) => ToolDef<SearchToolInput, SearchToolResult> | Exposes a Retriever to the model as a search tool. The tool is read-only; wrap it with a governance decorator to stamp lineage or route approvals. |
createSessionSubmissionExecutor | value | (options: SessionSubmissionExecutorOptions) => SubmissionExecutor | Provider-neutral durable submission executor for hosts that can open a Fabric session themselves. Node, Durable Objects, and custom runtimes share the same recovery and conservative interrupted-tool settlement behavior. |
createStdioMcpClient | value | (options: StdioMcpClientOptions) => StdioMcpClient | Creates stdio mcp client. |
createSubmissionRunner | value | (options: SubmissionRunnerOptions) => SubmissionRunner | Creates submission runner. |
createUnifiedInMemoryStore | value | () => UnifiedInMemoryStore | Factory that returns a fresh UnifiedInMemoryStore. The returned object can be passed as store, streamChunkStore, and runStore simultaneously. |
createVirtualSandboxEnv | value | (options?: SandboxFactoryOptions & { initialFiles?: Record<string, string | Uint8Array>; }) => VirtualSandboxEnv | Creates virtual sandbox env. |
CredentialMissingStrategy | type | "fail" | Type contract for credential missing strategy. |
currentJobInvocation | value | () => JobInvocationContext | undefined | Runtime API for current job invocation; the generated signature shows its accepted inputs and return type. |
currentSubmissionContext | value | () => SubmissionContext | undefined | The submission owning the current execution, or undefined outside one. |
DeepgramSttProvider | value | typeof DeepgramSttProvider | Provider implementation for deepgram stt. |
DeepgramSttProviderOptions | type | DeepgramSttProviderOptions | Configuration options for deepgram stt provider. |
DEFAULT_HEADLESS_PREAMBLE | value | "You are running in headless autonomous mode (background-agent mode) with no human operator assumed. Work autonomously: Do not ask clarifying questions or wait for in-band user input. Make safe, reasonable assumptions when possible; if blocked by missing credentials, unavailab... | Constant defining default headless preamble. |
defaultAgentProfile | value | AgentProfile | Runtime API for default agent profile; the generated signature shows its accepted inputs and return type. |
defaultLoopRuntime | value | NativeLoopRuntime | Runtime API for default loop runtime; the generated signature shows its accepted inputs and return type. |
defaultModelProvider | value | MockModelProvider | Provider implementation for default model. |
defaultSessionStore | value | InMemorySessionStore | Storage contract for default session. |
defineAction | value | <TInput = unknown, TOutput = unknown>(options: ActionOptions<TInput, TOutput>) => ActionDefinition<TInput, TOutput> | Define an action — the harness-context counterpart to defineTool. A tool is a leaf capability the model calls; an action holds the harness (context.init) and can prompt, spawn sessions, and compose other work. Input/output use the harness schema builders and are validated on every runAction call; outputs must be JSON-serializable. |
defineAgent | value | <TInput = JsonObject, TOutput = unknown>(definition: AgentDefinition<TInput, TOutput>) => DefinedAgent<TInput, TOutput> | Defaults-injecting finite-agent builder exported from the bare SDK entry point. |
defineAgentProfile | value | (options: AgentProfileOptions) => AgentProfile | Defines agent profile. |
defineChannel | value | (channel: Channel) => Channel | Validates and brands a channel's routes. |
defineCommand | value | <TInput = CommandToolInput>(name: string, options?: Omit<Command<TInput>, "name">) => Command<TInput> | Defines command. |
DefinedAgent | type | DefinedAgent<TInput, TOutput> | Type contract for defined agent. |
defineMcpConnection | value | (definition: McpConnectionDefinition) => McpConnectionDefinition | Defines mcp connection. |
defineSubagent | value | (definition: SubagentDefinition) => SubagentDefinition | Defines subagent. |
defineTool | value | { <TInput = unknown, TOutput = unknown>(tool: ToolDef<TInput, TOutput>): ToolDef<TInput, TOutput>; <TInput = unknown, TOutput = unknown, THarness extends boolean = false, TDurable extends boolean = false>(tool: HookToolDefinition<TInput, TOutput... | Defines tool. |
defineWebhookSubscription | value | <TPayload = JsonObject>(definition: WebhookSubscriptionDefinition<TPayload>) => WebhookSubscriptionDefinition<TPayload> | Helper that returns the definition unchanged. Useful for type inference and to keep agent files declarative. See the package declarations for an example. |
DeletionCompletionRecord | type | DeletionCompletionRecord | Type contract for deletion completion record. |
DeliveredAttachment | type | DeliveredAttachment | One attachment on a kind: 'user' message. Today the only supported attachment is an image, carried either inline (data, base64) or as a durable content-addressed reference (ref) once an attachment store is configured — admission materializes inline bytes into refs. An attachment must carry data or ref (or both, transiently during materialization). |
DeliveredAttachmentRef | type | DeliveredAttachmentRef | Durable reference to attachment bytes in an attachment store. |
DeliveredMessage | type | DeliveredMessage | DeliveredMessage — the single unified input shape for everything that enters a persistent agent's session: direct HTTP prompts, dispatch, channels/webhooks, Databricks events, SDK clients, and tests. kind: 'user' is a direct user talking to the assistant (1:1 chat surface), optionally carrying attachments. kind: 'signal' models everything beyond that direct exchange — a Slack thread or a Lakeflow job event is activity the agent observes, not the assistant's own user speaking. Sender identity and structured metadata go in attributes; the message itself in body. Signals render into mo... |
deliveredSignalToEntryData | value | (message: Extract<DeliveredMessage, { kind: "signal"; }>) => SignalEntryData | Map a signal-kind message onto the persisted signal entry's data shape. |
deriveCompactionDefaults | value | (input: { contextWindowTokens: number; maxOutputTokens?: number; }) => { reserveTokens: number; keepRecentTokens: number; } | Compute model-aware compaction defaults. Reserve is capped at the model's max output because reserving more than the model can emit in one turn wastes context; the preserved tail stays flat because recent-context fidelity depends on the active work, not on the model's total window size. |
dispatch | value | { (agent: CreatedAgent, request: AgentDispatchRequest): Promise<DispatchReceipt>; (request: NamedAgentDispatchRequest): Promise<DispatchReceipt>; } | Runtime API for dispatch; the generated signature shows its accepted inputs and return type. |
DispatchInput | type | DispatchInput | Internal enqueued form, carrying correlation + isolation metadata. |
DispatchProcessor | type | DispatchProcessor | Consumes enqueued dispatches and applies them to an instance session. |
DispatchQueue | type | DispatchQueue | Admission queue for dispatches. The default is in-process; durable backends implement the same shape. |
DispatchReceipt | type | DispatchReceipt | Acceptance confirmation for an enqueued dispatch. |
DockerSandboxEnv | value | typeof DockerSandboxEnv | Runtime API for docker sandbox env; the generated signature shows its accepted inputs and return type. |
DockerSandboxOptions | type | DockerSandboxOptions | Configuration options for docker sandbox. |
DURABILITY_DEFAULT_MAX_ATTEMPTS | value | 10 | Default maximum total attempts before terminalization. |
DURABILITY_DEFAULT_TIMEOUT_MS | value | 3600000 | Default submission timeout in milliseconds (one hour). |
DurableSessionRuntime | type | DurableSessionRuntime | Structural delegate for durable session execution. When init() is given a sessionRuntime factory that produces one of these, the SDK's session calls (prompt, task, shell, checkpoint.*) are routed through the runtime instead of executing inline. This is the seam for Temporal workflows, external orchestration runtimes, or test fakes. mount, history, artifact, and compact remain SDK-local concerns and are not delegated — they operate against the local session store. |
DurableSessionRuntimeFactory | type | DurableSessionRuntimeFactory | Factory for durable session runtime. |
DynamicAgentExecutionDescriptor | type | DynamicAgentExecutionDescriptor | JSON-safe identity required to re-render a persistent dynamic agent at a trusted durable-runtime boundary. Hook functions, tool implementations, credentials, and resolved MCP connections are deliberately excluded. |
DynamicAgentFinishContext | type | DynamicAgentFinishContext | Type contract for dynamic agent finish context. |
DynamicAgentFunction | type | DynamicAgentFunction<TEnv> | Type contract for dynamic agent function. |
DynamicAgentProps | type | DynamicAgentProps<TEnv> | Dynamic persistent-agent composition. The runtime keeps Fabric's builders, policies, persistence contracts, and backend-neutral types while allowing capabilities to evolve per interaction. |
DynamicAgentRefreshInput | type | DynamicAgentRefreshInput | Type contract for dynamic agent refresh input. |
DynamicAgentRenderOptions | type | DynamicAgentRenderOptions | Configuration options for dynamic agent render. |
DynamicAgentResponse | type | DynamicAgentResponse | Response contract for dynamic agent. |
DynamicAgentRuntime | type | DynamicAgentRuntime | Type contract for dynamic agent runtime. |
DynamicAgentStartContext | type | DynamicAgentStartContext | Type contract for dynamic agent start context. |
DynamicLifecycleContext | type | DynamicLifecycleContext | Type contract for dynamic lifecycle context. |
DynamicMetadataCallback | type | DynamicMetadataCallback | Type contract for dynamic metadata callback. |
editFileTool | value | (sandbox?: SandboxEnv) => ToolDef<EditInput, void> | Model-callable tool or tool factory for edit file. |
EditInput | type | EditInput | Type contract for edit input. |
ElevenLabsTtsProvider | value | typeof ElevenLabsTtsProvider | Provider implementation for eleven labs tts. |
ElevenLabsTtsProviderOptions | type | ElevenLabsTtsProviderOptions | Configuration options for eleven labs tts provider. |
EmbeddingProvider | type | EmbeddingProvider | Embeddings seam. Feeds self-managed-embedding vector indexes (embed the query → query vector) and any bring-your-own retrieval pipeline. Returns one vector per input text, order-preserving. |
emitOpenTelemetrySpan | value | (tracer: Tracer, span: TelemetrySpan, attributes?: Record<string, string | number | boolean>, conventions?: "fabric" | "foundry") => Span | Runtime API for emit open telemetry span; the generated signature shows its accepted inputs and return type. |
emitSubmissionTelemetry | value | (sink: SubmissionTelemetrySink | undefined, event: SubmissionTelemetryEvent, onError?: (error: unknown) => void) => void | Deliver an event to a sink, swallowing (and reporting) sink failures. |
EmptySandboxEnv | value | typeof EmptySandboxEnv | Runtime API for empty sandbox env; the generated signature shows its accepted inputs and return type. |
enqueueDispatch | value | (queue: DispatchQueue, request: NamedAgentDispatchRequest, extra?: { tenantId?: string; actor?: FabricActor; dispatchId?: string; }) => Promise<DispatchReceipt> | Validate + normalize a named request and enqueue it, generating the dispatch id. |
ensurePersistentInstanceIdentity | value | (options: { store: SessionStore; agentName: string; instanceId: string; uid?: string | null; tenantId?: string; actor?: FabricActor; }) => Promise<PersistentInstanceIdentity> | Atomically resolve or create one tenant-scoped persistent instance generation. |
entryToTelemetrySpan | value | (sessionId: string, entry: SessionEntry) => TelemetrySpan | undefined | Runtime API for entry to telemetry span; the generated signature shows its accepted inputs and return type. |
environmentSecretProvider | value | (options?: EnvironmentSecretProviderOptions) => SecretProvider | Runtime-only environment provider with optional prefix and explicit allowlist. |
EnvironmentSecretProviderOptions | type | EnvironmentSecretProviderOptions | Configuration options for environment secret provider. |
estimateCostUsd | value | (modelRef: string, usage: ModelPricingUsage) => number | Estimate USD cost for a single model call. Returns 0 when no row matches modelRef — callers should treat 0 as "unknown" and not overwrite an existing costUsd from the provider. |
estimateModelMessagesTokens | value | (messages: ModelMessage[]) => number | Runtime API for estimate model messages tokens; the generated signature shows its accepted inputs and return type. |
estimateSessionEntriesTokens | value | (entries: SessionEntry[]) => number | Runtime API for estimate session entries tokens; the generated signature shows its accepted inputs and return type. |
estimateTextTokens | value | (text: string) => number | Runtime API for estimate text tokens; the generated signature shows its accepted inputs and return type. |
evaluateCommandPolicy | value | (command: string | undefined, policy?: CapabilityPolicy) => PolicyDecision | Runtime API for evaluate command policy; the generated signature shows its accepted inputs and return type. |
evaluateContextBudget | value | (messages: ModelMessage[], options?: ContextBudgetOptions) => ContextBudget | Runtime API for evaluate context budget; the generated signature shows its accepted inputs and return type. |
evaluateNetworkPolicy | value | (input: string | URL | Request, policy?: CapabilityPolicy) => PolicyDecision | Evaluate a URL or Request against the configured network policy. Returns { allowed: true } when the request is permitted, otherwise a denial with the reason and matched pattern. |
evaluateOperationalSlos | value | (snapshot: OperationalMetricsSnapshot, targets: OperationalSloTargets) => OperationalSloEvaluation | Runtime API for evaluate operational slos; the generated signature shows its accepted inputs and return type. |
evaluateToolCallPolicy | value | (call: ToolCall, policy?: CapabilityPolicy) => PolicyDecision | Runtime API for evaluate tool call policy; the generated signature shows its accepted inputs and return type. |
eventToTelemetrySpan | value | (event: FabricEvent) => TelemetrySpan | undefined | Runtime API for event to telemetry span; the generated signature shows its accepted inputs and return type. |
execSandboxCommand | value | (sandbox: SandboxEnv, command: string, options?: SandboxExecOptions) => Promise<ShellResult> | Reject promptly on cancellation even when a remote provider cannot cancel its command. The underlying promise remains observed and reports its final, redacted settlement through onOrphanSettled. |
ExistsInput | type | ExistsInput | Type contract for exists input. |
existsTool | value | (sandbox?: SandboxEnv) => ToolDef<ExistsInput, boolean> | Model-callable tool or tool factory for exists. |
extractResultValue | value | (value: unknown, extraction?: boolean | ResultExtractionOptions) => unknown | Runtime API for extract result value; the generated signature shows its accepted inputs and return type. |
FABRIC_OPERATIONAL_METRICS | value | { readonly requestLatencyMs: "fabric_harness_request_latency_ms"; readonly submissionDurationMs: "fabric_harness_submission_duration_ms"; readonly queueAgeMs: "fabric_harness_queue_age_ms"; readonly errorsTotal: "fabric_harness_errors_total"; readonly approvalWaitMs: "fab... | Constant defining fabric operational metrics. |
FabricActor | type | FabricActor | Type contract for fabric actor. |
FabricAgent | type | FabricAgent | Type contract for fabric agent. |
FabricContext | type | FabricContext<TPayload> | Type contract for fabric context. |
FabricError | value | typeof FabricError | Error raised for fabric failures. |
FabricErrorCode | type | FabricErrorCode | Type contract for fabric error code. |
FabricErrorOptions | type | FabricErrorOptions | Configuration options for fabric error. |
FabricEvent | type | FabricEvent<TData> | Type contract for fabric event. |
FabricEventCallback | type | FabricEventCallback | Type contract for fabric event callback. |
FabricEventType | type | FabricEventType | Type contract for fabric event type. |
FabricFs | type | FabricFs | Out-of-band filesystem surface for a session sandbox. These operations do not write to conversation history and are intended for host-side plumbing: staging files, collecting artifacts, and preparing scratch space. If the model should reason about a file, prompt it to use the normal read/write/edit tools instead. |
FabricObservabilityRecord | type | FabricObservabilityRecord | Type contract for fabric observability record. |
FabricPrincipal | type | FabricPrincipal | The governed identity a piece of work runs as (v2). Distinct from ActorIdentity (who asked): the principal is what the platform's access control enforces — a human user, a machine service principal, or a hosted app's own identity. ucPrincipal carries the catalog-governance principal name when the platform has one (e.g. Unity Catalog). |
FabricRuntime | type | FabricRuntime | Execution runtime selection. - inline (default): single-process execution. Uses the configured SessionStore (in-memory by default) for history, artifacts, approvals. - stateless: explicit headless / ephemeral mode. No session store, no artifact persistence, no approval waiting. Each invocation is independent. Use for high-volume webhook agents and edge runtimes where state would just be discarded anyway. In production (FABRIC_ENV=production or NODE_ENV=production) this mode must be selected explicitly — inline without an explicit store will warn or fail depending on `FABRIC_ALLO... |
FabricSession | type | FabricSession | Type contract for fabric session. |
FallbackModelProvider | value | typeof FallbackModelProvider | Provider implementation for fallback model. |
FallbackModelProviderOptions | type | FallbackModelProviderOptions | Configuration options for fallback model provider. |
FileStat | type | FileStat | Type contract for file stat. |
FilesystemEntry | type | FilesystemEntry | Type contract for filesystem entry. |
FilesystemPolicy | type | FilesystemPolicy | Type contract for filesystem policy. |
FilesystemSource | type | FilesystemSource | A read-only content source that can be mounted into a sandbox at sandbox-creation time. The agent then has built-in read, glob, and grep tools available over the mounted content — no retrieval pipeline, no embeddings, no vector store required. Sources are intentionally minimal: they yield (path, content) pairs. Implementations decide how to enumerate (eager vs lazy is up to the source author) — the mount step pulls the full set into the sandbox. |
findSubmissionInputIndex | value | (path: readonly SessionEntry[], submissionId: string) => number | Index of the last canonical user or signal input carrying the submission id, or -1. |
findTrailingDanglingToolCalls | value | (path: SessionEntry[]) => SessionEntry[] | Find trailing tool_call entries on the active path that were never settled — no matching tool_result (paired by toolCallId, falling back to tool name) and no subsequent error entry for the same tool. A dangling call means a model turn died (crash/abort) between recording the call and recording its outcome. Left in place it produces an assistant tool_use with no tool_result on resume, which providers reject — the repair path appends synthetic interrupted outcomes for exactly the entries returned here. Conservative by construction: only the window after the last turn boundary (use... |
findTrailingUnfinishedTasks | value | (path: SessionEntry[]) => SessionEntry[] | Trailing task_start entries in the same window with no matching task_end — a subtask that was in flight when the turn died. These do not corrupt model context (task entries are bookkeeping), but settling them keeps UI/audit state coherent. |
formatSchemaIssues | value | (issues: SchemaIssue[]) => string | Runtime API for format schema issues; the generated signature shows its accepted inputs and return type. |
formatStreamOffset | value | (offset: number) => string | Runtime API for format stream offset; the generated signature shows its accepted inputs and return type. |
fumadocsSource | value | (contentRoot: string, options?: { name?: string; stripFrontmatter?: boolean; include?: (relativePath: string) => boolean; }) => FilesystemSource | Mount a local Fumadocs content directory as a knowledge base. Strips MDX frontmatter by default for cleaner agent context. For a published Fumadocs site, fetch its llms.txt / sitemap and pass the URLs to httpFilesystemSource. |
GeminiModelProvider | value | typeof GeminiModelProvider | Provider implementation for gemini model. |
GeminiProviderOptions | type | GeminiProviderOptions | Configuration options for gemini provider. |
GeneralSubagent | value | SubagentDefinition | Runtime API for general subagent; the generated signature shows its accepted inputs and return type. |
generateAffinityKey | value | (agentId: string, sessionId: string) => string | Generate a deterministic aff_\u003cULID\u003e affinity key from an (agentId, sessionId) pair. The same pair always produces the same key, which is stable across restarts. Different pairs produce different keys with overwhelming probability. |
generateWithRuntime | value | (provider: ModelProvider, request: ModelRequest, options?: ModelRuntimeOptions) => Promise<ModelResponse> | Runtime API for generate with runtime; the generated signature shows its accepted inputs and return type. |
getAgentDefinition | value | (value: unknown) => AgentDefinition<unknown, unknown> | undefined | Returns agent definition. |
getCreatedAgent | value | (value: unknown) => CreatedAgent | undefined | Return the CreatedAgent carried by a value, or undefined. |
getLogger | value | () => Logger | Get the currently configured logger. |
getVirtualSandbox | value | (source: FilesystemSource, options?: { mountAt?: string; }) => SandboxFactory | One-liner helper for the most common pattern: mount a single read-only source into a virtual sandbox. Equivalent to: See the package declarations for an example. Used for support agents, runbook lookup, FAQ assistants — anywhere a small Markdown corpus needs to be searchable via the agent's built-in grep/glob/read tools. See the package declarations for an example. |
GlobInput | type | GlobInput | Type contract for glob input. |
globTool | value | (sandbox?: SandboxEnv) => ToolDef<GlobInput, string[]> | Model-callable tool or tool factory for glob. |
GrepInput | type | GrepInput | Type contract for grep input. |
GrepMatch | type | GrepMatch | Type contract for grep match. |
grepTool | value | (sandbox?: SandboxEnv) => ToolDef<GrepInput, GrepMatch[]> | Model-callable tool or tool factory for grep. |
hasSubmissionSettledEntry | value | (path: readonly SessionEntry[], submissionId: string) => boolean | True when the path carries a canonical submission_settled entry for the id. |
hexToBytes | value | (hex: string) => Uint8Array | Runtime API for hex to bytes; the generated signature shows its accepted inputs and return type. |
hmacSha256 | value | (secret: string | Uint8Array, message: Uint8Array) => Promise<Uint8Array> | Runtime API for hmac sha256; the generated signature shows its accepted inputs and return type. |
HookToolContext | type | HookToolContext<TInput, THarness, TDurable> | Type contract for hook tool context. |
HookToolDefinition | type | HookToolDefinition<TInput, TOutput, THarness, TDurable> | Hook-oriented tool declaration supported by defineTool() and useTool(). |
httpFilesystemSource | value | (resources: HttpResource[] | (() => Promise<HttpResource[]>), options?: { name?: string; fetchImpl?: typeof fetch; }) => FilesystemSource | Fetch a list of URLs and mount each response body as a file. Useful for pulling a small published docs set into the sandbox so the built-in read/grep/glob tools can search it like local files. |
HttpResource | type | HttpResource | Type contract for http resource. |
init | value | (options?: AgentInit) => Promise<FabricAgent> | Initialize a runtime-neutral Fabric agent from explicit model, sandbox, policy, store, identity, and lifecycle options. Call agent.session() on the returned value to create or resume a session. Supplying both store and persistence is invalid; a persistence adapter is connected before the agent is returned and connection failures propagate to the caller. |
initializePersistentAgent | value | <TEnv>(created: CreatedAgent<TEnv>, context: PersistentAgentContext<TEnv>, overrides?: AgentInit) => Promise<{ config: PersistentAgentConfig; agent: FabricAgent; }> | Resolve a persistent agent's config for an instance and build a FabricAgent. Runtime-specific resources (session store, workspace roles/skills, loop runtime) are layered by the host that calls this. |
inMemoryApprovalNotificationStore | value | () => ApprovalNotificationDeliveryStore | Process-local atomic delivery state for development and single-process hosts. |
InMemoryAttachmentStore | value | typeof InMemoryAttachmentStore | In-memory attachment store (dev / runtime: 'stateless' / tests). |
InMemoryConversationStreamStore | value | typeof InMemoryConversationStreamStore | In-memory conversation stream store (dev / runtime: 'stateless' / tests). |
inMemoryCostBudgetStore | value | () => CostBudgetStore | Process-local cost budget store. Default when store is not provided. |
InMemoryDispatchQueue | value | typeof InMemoryDispatchQueue | In-process dispatch queue: microtask-drained, concurrent across sessions, serialized within a single session. Suitable for the inline/stateless runtimes and dev. Durable delivery (surviving restarts) is provided by the Temporal-backed queue, which implements this same interface. |
inMemorySessionMemory | value | () => SessionMemory | Process-local in-memory implementation. Default when init({ memory }) is not configured — pair with Postgres for durability across restarts. |
InMemorySessionStore | value | typeof InMemorySessionStore | Storage contract for in memory session. |
inMemorySource | value | (files: Record<string, string | Uint8Array>, options?: { name?: string; }) => FilesystemSource | Build a source from an in-memory map of path -> content. Useful for tests, fixtures, and small static knowledge bases bundled into the agent module itself. |
InMemoryStreamChunkStore | value | typeof InMemoryStreamChunkStore | Storage contract for in memory stream chunk. |
InMemorySubmissionStore | value | typeof InMemorySubmissionStore | Storage contract for in memory submission. |
InterruptedToolCallRef | type | InterruptedToolCallRef | A tool call settled with an explicit interrupted-outcome marker at terminalization. |
InvalidDeliveredMessageError | value | typeof InvalidDeliveredMessageError | Thrown by parseDeliveredMessage on malformed input. |
invoke | value | { <TInput = JsonObject, TOutput = unknown>(job: DefinedAgent<TInput, TOutput>, options: JobInvocationOptions<TInput>): Promise<JobInvocationReceipt>; <TInput = JsonObject>(request: NamedJobInvocation<TInput>): Promise<JobInvocationRe... | Runtime API for invoke; the generated signature shows its accepted inputs and return type. |
isActionDefinition | value | (value: unknown) => value is ActionDefinition | Checks whether a value is action definition. |
isContextOverflowError | value | (error: unknown) => boolean | Checks whether a value is context overflow error. |
isCreatedAgent | value | (value: unknown) => value is CreatedAgent | Whether a value is a CreatedAgent. |
isDeliveredMessageShape | value | (value: unknown) => boolean | True when a raw value already looks like a DeliveredMessage (has a valid kind). |
isDynamicAgentRendering | value | () => boolean | Checks whether a value is dynamic agent rendering. |
isEvent | value | <T extends AgentEventType>(event: AgentEvent, type: T) => event is Extract<AgentEvent, { type: T; }> | Type guard: narrow an AgentEvent to a specific variant. See the package declarations for an example. |
isFabricError | value | (error: unknown) => error is FabricError | Checks whether a value is fabric error. |
isInMemoryStore | value | (store: SessionStore | undefined) => boolean | Returns true when store is the in-memory default (no appendEntry persistence beyond memory). Used by stateless mode to skip writes. |
isStatelessRuntime | value | (runtime: FabricRuntime | undefined) => boolean | Checks whether a value is stateless runtime. |
isSubmissionPayload | value | (input: unknown, ctx: SubmissionPayloadContext) => input is AgentSubmissionInput | Validate that a parsed JSON payload matches the expected submission shape. Used after deserializing a persisted payload to verify the object is a well-formed AgentSubmissionInput that is consistent with the stored submission metadata. Both dispatch and direct payloads carry the same message: DeliveredMessage field — validated identically here regardless of transport kind. |
isValidAffinityKey | value | (key: string) => boolean | Checks whether a value is valid affinity key. |
JobInvocationContext | type | JobInvocationContext | Type contract for job invocation context. |
JobInvocationOptions | type | JobInvocationOptions<TInput> | Configuration options for job invocation. |
JobInvocationReceipt | type | JobInvocationReceipt | Type contract for job invocation receipt. |
JobInvocationRuntime | type | JobInvocationRuntime | Type contract for job invocation runtime. |
JournalCallbacks | type | JournalCallbacks | Type contract for journal callbacks. |
jsonDeepEqual | value | (a: unknown, b: unknown) => boolean | Structural equality over JSON values (objects compared key-order-insensitively). |
JsonObject | type | JsonObject | Type contract for json object. |
JsonPrimitive | type | JsonPrimitive | Type contract for json primitive. |
JsonSchemaObject | type | JsonSchemaObject | Type contract for json schema object. |
JsonValue | type | JsonValue | Type contract for json value. |
LangfuseClientLike | type | LangfuseClientLike | Optional Langfuse exporter. Adapts Fabric's TelemetrySpan shape to Langfuse's tracing API. The Langfuse client is provided by the caller — we don't take a hard dependency. Install peer dep: See the package declarations for an example. Usage: See the package declarations for an example. |
langfuseExporter | value | (options: LangfuseExporterOptions) => TelemetryExporter | Runtime API for langfuse exporter; the generated signature shows its accepted inputs and return type. |
LangfuseExporterOptions | type | LangfuseExporterOptions | Configuration options for langfuse exporter. |
LEASE_DURATION_MS | value | 30000 | Default lease duration for submission ownership in milliseconds (30 seconds). |
listModelPrices | value | () => ModelPriceRow[] | All currently-registered rows (newest-last). Returns a copy. |
listSandboxBackendFactories | value | () => SandboxBackend[] | Return provider backend names currently available to createSandboxEnv(). |
listSandboxRefDecoders | value | () => string[] | Returns the list of currently registered providers. |
localDirectorySource | value | (hostPath: string, options?: { name?: string; include?: (relativePath: string) => boolean; }) => FilesystemSource | Read a host directory recursively as a read-only source. include is called for each candidate file path (relative to hostPath). Return false to skip. Defaults to including everything. |
LocalSandboxEnv | value | typeof LocalSandboxEnv | Runtime API for local sandbox env; the generated signature shows its accepted inputs and return type. |
LocalSandboxOptions | type | LocalSandboxOptions | Configuration options for local sandbox. |
Logger | type | Logger | Minimal logger seam used by the SDK for non-event diagnostic output (warnings, deprecation notices, telemetry fallbacks). All console.* inside the SDK should route through getLogger() so ops teams can redirect or silence messages in production. The default logger writes to console and respects FABRIC_HARNESS_LOG_LEVEL=debug|info|warn|error|silent (default warn). |
LogLevel | type | LogLevel | Type contract for log level. |
lookupModelPrice | value | (modelRef: string) => ModelPriceRow | undefined | Look up the most recently-registered row matching modelRef. modelRef can be: - 'provider/model' (preferred, e.g. 'openai/gpt-4o') - 'model' alone (e.g. 'gpt-4o') — first row whose model matches wins Provider matching is case-insensitive. Model matching is exact. |
materializeMessageAttachments | value | (message: DeliveredMessage, store: AttachmentStore, options: { scope: string; idPrefix: string; maxCount?: number; maxAttachmentBytes?: number; maxTotalBytes?: number; }) => Promise<DeliveredMessage> | Materialize a message's inline attachments into durable refs: decode the base64 data, store the bytes under scope, and return a NEW message whose attachments carry { type, mimeType, filename?, ref } and no data. Deterministic by construction — attachment ids are ${idPrefix}_${index} and digests derive from content — so an exact redelivery of the same message produces an identical materialized payload (admission idempotency). Messages without inline attachments are returned unchanged (same reference). |
MAX_ATTACHMENT_DATA_LENGTH | value | number | Maximum accepted base64 length for a single inline attachment. |
McpAuthorizationCodeOptions | type | McpAuthorizationCodeOptions | Configuration options for mcp authorization code. |
McpAuthorizationCodeState | type | McpAuthorizationCodeState | Type contract for mcp authorization code state. |
McpClientCredentialsOptions | type | McpClientCredentialsOptions | Configuration options for mcp client credentials. |
McpClientLike | type | McpClientLike | Type contract for mcp client like. |
McpConnectionDefinition | type | McpConnectionDefinition | Type contract for mcp connection definition. |
McpServerConnection | type | McpServerConnection | Type contract for mcp server connection. |
McpServerOptions | type | McpServerOptions | Configuration options for mcp server. |
McpToolDescriptor | type | McpToolDescriptor | Type contract for mcp tool descriptor. |
McpTransport | type | McpTransport | Type contract for mcp transport. |
memorySandboxOwnershipLeaseStore | value | () => SandboxOwnershipLeaseStore | Process-local lease store for tests and single-replica durable workers. |
mergeCapabilityPolicies | value | (definition: CapabilityPolicy | undefined, invocation: CapabilityPolicy | undefined) => CapabilityPolicy | undefined | Treat a definition policy as a security floor. Invocation policy can add denials and approval requirements, but cannot replace definition allowlists. |
mergeSessionEntryBatch | value | (existing: SessionData, entries: readonly SessionEntry[], expectedLeafId?: string, enforceExpectedLeaf?: boolean) => SessionData | false | Merge one idempotent, leaf-fenced entry batch into a session snapshot. Exported for first-party storage adapters so every backend applies the same conflict and exact-replay semantics before its single atomic write. |
messageHasDataAttachments | value | (message: DeliveredMessage) => boolean | True when the message carries at least one inline (base64) attachment. |
mintlifySource | value | (contentRoot: string, options?: { name?: string; include?: (relativePath: string) => boolean; }) => FilesystemSource | Mount a checked-out Mintlify content directory. For a hosted Mintlify MCP server, use connectMcpServer('mintlify', { url, transport: 'streamable-http' }) instead. |
MissingInputStrategy | type | MissingInputStrategy | Type contract for missing input strategy. |
MkdirInput | type | MkdirInput | Type contract for mkdir input. |
mkdirTool | value | (sandbox?: SandboxEnv) => ToolDef<MkdirInput, void> | Model-callable tool or tool factory for mkdir. |
ModelAttemptEvent | type | ModelAttemptEvent | Type contract for model attempt event. |
ModelConfig | type | ModelConfig | Type contract for model config. |
ModelMessage | type | ModelMessage | Type contract for model message. |
ModelMessageRole | type | ModelMessageRole | Type contract for model message role. |
ModelMetadata | type | ModelMetadata | Type contract for model metadata. |
ModelPriceRow | type | ModelPriceRow | Static USD price table for model providers. Used to populate ModelUsage.costUsd on responses that don't include billing info from the provider directly (most providers — only pi-loop-runtime and a handful of gateways report cost). Prices are stamped with effectiveAt. The table is best-effort: real billing reconciliation should use vendor invoices. Override or extend at runtime with registerModelPrices for custom-rate contracts. |
ModelPricingUsage | type | ModelPricingUsage | Type contract for model pricing usage. |
ModelProvider | type | ModelProvider | Provider implementation for model. |
ModelProviderFactory | type | ModelProviderFactory | Resolves a parsed provider/model-id ref into a concrete provider. Registered factories let out-of-core packages (e.g. |
ModelProviderResolver | type | ModelProviderResolver | Type contract for model provider resolver. |
ModelRequest | type | ModelRequest | Input contract for model. |
ModelResponse | type | ModelResponse | Response contract for model. |
ModelRuntimeOptions | type | ModelRuntimeOptions | Configuration options for model runtime. |
ModelStreamChunk | type | ModelStreamChunk | Type contract for model stream chunk. |
ModelToolCall | type | ModelToolCall | Type contract for model tool call. |
ModelToolSchema | type | ModelToolSchema | Type contract for model tool schema. |
ModelUsage | type | ModelUsage | Type contract for model usage. |
MountedSource | type | MountedSource | Data or filesystem source for mounted. |
MountResult | type | MountResult | Result returned by mount. |
NamedAgentDispatchRequest | type | NamedAgentDispatchRequest | A dispatch request that names its target agent. |
NamedJobInvocation | type | NamedJobInvocation<TInput> | Type contract for named job invocation. |
NativeLoopRuntime | value | typeof NativeLoopRuntime | Runtime API for native loop runtime; the generated signature shows its accepted inputs and return type. |
negotiateSandboxContinuity | value | (value: SandboxEnv | SandboxRef | SerializedSandboxRef) => SandboxContinuityCapabilities | Report the continuity operations that a backend or serialized ref can support. |
NetworkEnforcementLayer | type | NetworkEnforcementLayer | Type contract for network enforcement layer. |
NetworkEnforcementRequirement | type | NetworkEnforcementRequirement | Type contract for network enforcement requirement. |
NetworkPolicy | type | NetworkPolicy | Type contract for network policy. |
noopSessionStore | value | NoopSessionStore | Storage contract for noop session. |
NoopSessionStore | value | typeof NoopSessionStore | No-op session store for runtime: 'stateless' mode. All writes are discarded; reads always return the empty initial session. Use this when the agent is intended as a pure request/response handler with no persistence (typical for high-volume webhooks and edge runtimes). Approvals and artifact retrieval are not supported — wiring those up requires a real store. Callers in stateless mode should not rely on artifact persistence or approval gating. |
normalizeDeliveredMessage | value | (input: unknown) => DeliveredMessage | Normalize legacy inputs into a DeliveredMessage: - a string → a user message with that body - a value with a kind discriminator → validated as a DeliveredMessage - any other JSON value → a user message with the JSON-stringified body (matching the historical dispatch rendering, so behavior is unchanged for pre-DeliveredMessage callers) |
ObservabilityCorrelation | type | ObservabilityCorrelation | Type contract for observability correlation. |
ObservabilityObserverOptions | type | ObservabilityObserverOptions | Configuration options for observability observer. |
OpenAIChatCompletion | type | OpenAIChatCompletion | Type contract for open aichat completion. |
openAIChatCompletionToModelResponse | value | (json: OpenAIChatCompletion) => ModelResponse | Response contract for open aichat completion to model. |
OpenAICompatibleModelProvider | value | typeof OpenAICompatibleModelProvider | Provider implementation for open aicompatible model. |
OpenAICompatibleProviderOptions | type | OpenAICompatibleProviderOptions | Configuration options for open aicompatible provider. |
OpenAIRealtimeVoiceProvider | value | typeof OpenAIRealtimeVoiceProvider | OpenAI Realtime voice provider. Connects via WebSocket; emits audio_delta / text_delta / transcript / tool_call / response_done events. No transitive dependency on ws — uses the global WebSocket available on Node 22+ and browsers. See the package declarations for an example. |
OpenAIRealtimeVoiceProviderOptions | type | OpenAIRealtimeVoiceProviderOptions | Configuration options for open airealtime voice provider. |
openTelemetryExporter | value | (options: OpenTelemetryExporterOptions) => TelemetryExporter | Bridge Fabric's SDK-neutral TelemetrySpan into a real |
OpenTelemetryExporterOptions | type | OpenTelemetryExporterOptions | Configuration options for open telemetry exporter. |
OperationalMetricsCollector | type | OperationalMetricsCollector | Type contract for operational metrics collector. |
OperationalMetricsSnapshot | type | OperationalMetricsSnapshot | Type contract for operational metrics snapshot. |
OperationalSloEvaluation | type | OperationalSloEvaluation | Type contract for operational slo evaluation. |
OperationalSloTargets | type | OperationalSloTargets | Type contract for operational slo targets. |
parseConversationKey | value | (key: string) => ParsedConversationKey | Parses conversation key. |
ParsedConversationKey | type | ParsedConversationKey | Type contract for parsed conversation key. |
parseDeliveredMessage | value | (value: unknown) => DeliveredMessage | Validate a raw value as a DeliveredMessage. Shared by dispatch admission and the direct HTTP route so every transport produces the same structured error on bad input. |
ParsedModelRef | type | ParsedModelRef | Type contract for parsed model ref. |
ParsedScopeKey | type | ParsedScopeKey | Type contract for parsed scope key. |
parseModelRef | value | (model: string) => ParsedModelRef | undefined | Parses model ref. |
parsePersistentSessionId | value | (storeSessionId: string) => PersistentSessionIdentity | undefined | Inverse of persistentStoreSessionId: decode a store session id back into { agent, instanceId, session }, or undefined if it is not a persistent-instance key. Useful for admin surfaces that list raw session ids. |
parseRetryAfterMs | value | (headerValue: string | null | undefined) => number | undefined | Parse a Retry-After header value (RFC 7231) into milliseconds. Accepts both delta-seconds and HTTP-date forms. Returns undefined when the value is missing or unparseable. |
parseScopeKey | value | (scopeKey: string) => ParsedScopeKey | undefined | Parse a scope key into its structured components. Recognized patterns: tenant:<id>:day:YYYY-MM-DD tenant:<id>:hour:YYYY-MM-DDTHH:00Z tenant:<id>:month:YYYY-MM agent:<id>:day:YYYY-MM-DD agent:<id>:hour:YYYY-MM-DDTHH:00Z agent:<id>:month:YYYY-MM user:<id>:day:YYYY-MM-DD user:<id>:hour:YYYY-MM-DDTHH:00Z user:<id>:month:YYYY-MM Unknown prefixes fall back to kind: 'custom' with raw: scopeKey. Returns undefined for empty strings. |
parseStreamOffset | value | (offset: string | undefined) => number | Parses stream offset. |
persistenceAdapter | value | () => PersistenceAdapter | Create an in-memory PersistenceAdapter backed by a fresh InMemorySessionStore. This is the default when no persistence is configured. The returned adapter's connect() always returns the same store instance. |
PersistenceAdapter | type | PersistenceAdapter | A persistence adapter abstracts over storage backends (SQLite, Postgres, file, etc.). The SDK only requires connect() → SessionStore. Optional methods connectRunStore and connectRunRegistry are used by workflow backends (Temporal, Cloudflare). The optional migrate() hook is called once at startup to ensure schema exists, and close() releases resources. |
PersistenceBundle | type | PersistenceBundle | Complete persistence surface consumed by a Fabric host. |
PersistenceDeleteResult | type | PersistenceDeleteResult | Result returned by persistence delete. |
PersistenceHealth | type | PersistenceHealth | Type contract for persistence health. |
PersistentAgentConfig | type | PersistentAgentConfig | Runtime configuration returned by a createAgent initializer. Mirrors the agent-level slice of AgentInit; instructions becomes the session system prompt (a role), and subagents map to named roles. |
PersistentAgentContext | type | PersistentAgentContext<TEnv> | Per-interaction context passed to a createAgent initializer. id is the URL <id> of the addressed instance (or the dispatch target id); env is the platform environment supplied by the runtime. |
PersistentAgentDurabilityConfig | type | PersistentAgentDurabilityConfig | Static retry and wall-clock budget applied to every durable submission. |
persistentAgentSubmissionDurability | value | (created: CreatedAgent, acceptedAt: number) => import("./submission-store.js").AgentSubmissionDurability | undefined | Resolve a static policy into the store's absolute durability stamp. |
PersistentAgentTriggers | type | PersistentAgentTriggers | Public triggers supported by persistent agents. Scheduling requires a concrete instance id and message, so cron belongs on a finite dispatcher job. |
persistentConfigToAgentInit | value | (config: PersistentAgentConfig, id: string) => AgentInit | Translate a PersistentAgentConfig into an AgentInit. |
PersistentInstanceIdentity | type | PersistentInstanceIdentity | Type contract for persistent instance identity. |
persistentInstanceStoreId | value | (agentName: string, instanceId: string) => string | Instance-scoped metadata key shared by every named session of one persistent agent. |
PersistentSessionIdentity | type | PersistentSessionIdentity | Decoded identity of a persistent instance session store key. |
persistentStoreSessionId | value | (agentName: string, instanceId: string, sessionName?: string) => string | Store-session key for a persistent instance's named session. Collapses the (agentName, instanceId, sessionName) identity onto Fabric's single-string sessionId, keeping persistent sessions inside the existing session stores. |
PipelineVoiceProvider | value | typeof PipelineVoiceProvider | Provider implementation for pipeline voice. |
PipelineVoiceProviderOptions | type | PipelineVoiceProviderOptions | Configuration options for pipeline voice provider. |
policiedFetch | value | (fetchImpl: typeof fetch, policy?: CapabilityPolicy, options?: PoliciedFetchOptions) => typeof fetch | Wrap a Fetch implementation with URL, protocol, host, redirect, and optional DNS-answer checks from a capability policy. This wrapper governs only calls made through the returned function; it does not intercept global Fetch, Axios, raw sockets, subprocesses, or third-party clients. Pair it with a container, cluster, or provider egress boundary for untrusted production workloads. |
PoliciedFetchOptions | type | PoliciedFetchOptions | Wrap a fetch-like function with CapabilityPolicy enforcement. Tools and connectors that make outbound HTTP should accept a custom fetch and pass the result of policiedFetch(fetch, policy). Throws a FabricError (POLICY_DENIED) when a request violates the policy; never sends a forbidden request. |
PolicyDecision | type | PolicyDecision | Type contract for policy decision. |
projectConversationRecords | value | (records: readonly ConversationStreamRecord[]) => ConversationSnapshot | Project canonical session records into a stable, UI-oriented protocol. |
PromptOptions | type | PromptOptions<TResult> | Configuration options for prompt. |
PromptRunInput | type | PromptRunInput | Type contract for prompt run input. |
PromptRunResult | type | PromptRunResult | Result returned by prompt run. |
ProviderHttpError | value | typeof ProviderHttpError | Error raised for provider http failures. |
ProvidersConfig | type | ProvidersConfig | Type contract for providers config. |
ProviderSettings | type | ProviderSettings | Type contract for provider settings. |
pruneSnapshots | value | (snapshotRoot: string, options?: SnapshotPruneOptions) => Promise<SnapshotPruneResult> | Runtime API for prune snapshots; the generated signature shows its accepted inputs and return type. |
RateLimiter | type | RateLimiter | Type contract for rate limiter. |
RateLimiterAcquireOptions | type | RateLimiterAcquireOptions | Process-local rate limiter for outbound provider calls. Use to prevent a fleet of agents from stampeding a single API key when the host runs many sessions in parallel. The default token-bucket implementation is in-memory; @fabric-harness/node exports redisRateLimiter for shared limits across processes. fabric-harness ships this as a generic primitive — the same limiter can be reused for outbound HTTP calls inside connectors, webhook fan-out, or anywhere else throttling is useful. |
readConversationFromFold | value | (store: ConversationStreamStore, path: string, options?: { offset?: string; limit?: number; }) => Promise<ConversationStreamReadResult> | Read a conversation from its newest validated fold checkpoint plus the log suffix. Non-origin offsets always use the raw store so resume semantics stay unchanged. Invalid checkpoints are disposable and fall back to full replay. |
readConversationReply | value | (snapshot: ConversationSnapshot, submissionId: string) => ConversationReply | Read the canonical assistant reply for a durable submission. Submission ids are used when available. The positional fallback supports conversations written by older Harness servers that predate submission correlation on individual entries. |
ReaddirInput | type | ReaddirInput | Type contract for readdir input. |
readdirTool | value | (sandbox?: SandboxEnv) => ToolDef<ReaddirInput, string[]> | Model-callable tool or tool factory for readdir. |
ReadFileBufferInput | type | ReadFileBufferInput | Type contract for read file buffer input. |
readFileBufferTool | value | (sandbox?: SandboxEnv) => ToolDef<ReadFileBufferInput, Uint8Array> | Model-callable tool or tool factory for read file buffer. |
ReadFileInput | type | ReadFileInput | Type contract for read file input. |
readFileTool | value | (sandbox?: SandboxEnv, packagedSkills?: Record<string, PackagedSkillDirectory>) => ToolDef<ReadFileInput, string> | Model-callable tool or tool factory for read file. |
readJsonBody | value | (request: Request, limitBytes?: number) => Promise<RequestBody | undefined> | Reads the body once and returns the raw bytes, the decoded text, and the parsed JSON together — so a channel can HMAC-verify the exact bytes and use the JSON without re-reading the (already consumed) stream. Returns undefined only when the body exceeds limitBytes. |
readRequestBody | value | (request: Request, limitBytes?: number) => Promise<Uint8Array | undefined> | Reads the full request body as bytes, or returns undefined if it exceeds limitBytes. NOTE: this consumes the request stream (single read). Signature-verifying channels need the exact bytes for HMAC and the parsed JSON afterward — don't call request.json() as well. Use readJsonBody to get both from one read. |
ReconstructedPartialAssistantMessage | type | ReconstructedPartialAssistantMessage | Type contract for reconstructed partial assistant message. |
reconstructInterruptedStream | value | (segments: Array<{ segmentIndex: number; body: string; }>, streamKey: string) => { partial: ReconstructedPartialAssistantMessage; interrupted: SignalEntryData; continued: SignalEntryData; } | null | Runtime API for reconstruct interrupted stream; the generated signature shows its accepted inputs and return type. |
redactError | value | (error: unknown, options?: RedactionOptions) => JsonObject | Error raised for redact failures. |
RedactionOptions | type | RedactionOptions | Configuration options for redaction. |
redactJson | value | <T>(value: T, options?: RedactionOptions) => T | Runtime API for redact json; the generated signature shows its accepted inputs and return type. |
redactText | value | (value: string, options?: RedactionOptions) => string | Runtime API for redact text; the generated signature shows its accepted inputs and return type. |
registerCreatedAgentName | value | (agent: CreatedAgent, name: string) => void | Register a name for a CreatedAgent so dispatch(agent, ...) can resolve it. |
registeredModelProviders | value | () => string[] | Names of externally registered providers, for diagnostics. |
registerJobName | value | <TInput, TOutput>(job: DefinedAgent<TInput, TOutput>, name: string) => void | Registers job name. |
registerModelPrices | value | (rows: ModelPriceRow[]) => void | Add or override price rows. Later rows take precedence over earlier ones. |
registerModelProvider | value | (name: string, factory: ModelProviderFactory) => void | Register a model provider resolvable via FABRIC_MODEL=<name>/<model-id>. Built-in providers always take precedence; registering a name a built-in already owns has no effect on routing. Idempotent by name (last registration wins). Call at module import time. |
registerSandbox | value | (env: SandboxEnv, options?: { ownerSessionId?: string; }) => SandboxRef | Register a sandbox in the in-process registry and return a portable ref. Subsequent calls for the same env return the same ref. |
registerSandboxBackendFactory | value | (backend: SandboxBackend, factory: SandboxFactory) => void | Register an implementation for a non-core SandboxBackend name. Provider packages use this hook so the shared runtime can resolve backends such as databricks without depending on them. |
registerSandboxRefDecoder | value | (provider: string, decoder: SandboxRefDecoder) => void | Register a decoder for provider so attachSandbox(serialized) can rehydrate a sandbox from another process. Typically called once at startup by the package that owns the provider integration (e.g. @fabric-harness/connectors/e2b registers the e2b provider). |
RemoteSandboxApi | type | RemoteSandboxApi | Type contract for remote sandbox api. |
RemoteSandboxOptions | type | RemoteSandboxOptions | Configuration options for remote sandbox. |
renderDeliveredMessage | value | (message: DeliveredMessage) => string | Render a delivered message to the prompt text form. User messages pass their body through verbatim; signals render as their XML envelope via the shared renderSignalMessage machinery. |
RequestBody | type | RequestBody | Type contract for request body. |
resetDispatchRuntime | value | () => void | Clear the ambient dispatch runtime (tests/teardown). |
resetJobInvocationRuntime | value | () => void | Runtime API for reset job invocation runtime; the generated signature shows its accepted inputs and return type. |
resetModelPricesToBuiltins | value | () => void | Reset the registry to the built-in seed (test/utility). |
ResolvedDynamicModelProvider | type | ResolvedDynamicModelProvider | Provider and normalized model selected for a dynamically rendered model reference. |
ResolvedModelProvider | type | ResolvedModelProvider | Provider implementation for resolved model. |
resolveModelProvider | value | (options?: ResolveModelProviderOptions) => ResolvedModelProvider | Resolves model provider. |
ResolveModelProviderOptions | type | ResolveModelProviderOptions | Configuration options for resolve model provider. |
resolveRuntimeMode | value | (options: Pick<AgentInit, "runtime" | "store" | "persistence">, env?: Record<string, string | undefined>) => RuntimeModeResolution | Resolve the effective runtime mode for an init() call, applying production safety rules: - In production (FABRIC_ENV=production or NODE_ENV=production), choosing stateless is allowed but logged as an explicit choice. - inline (the default) without an explicit SessionStore falls back to in-memory storage. In production this emits a warning unless FABRIC_ALLOW_EPHEMERAL_STATE=1 is set or runtime is explicitly 'stateless'. - Unknown runtime values fall through to 'inline' with a warning. |
RESULT_END_DELIMITER | value | "---RESULT_END---" | Constant defining result end delimiter. |
RESULT_START_DELIMITER | value | "---RESULT_START---" | Constant defining result start delimiter. |
ResultExtractionOptions | type | ResultExtractionOptions | Configuration options for result extraction. |
ResultOutcome | type | ResultOutcome<TResult> | Type contract for result outcome. |
ResultToolBundle | type | ResultToolBundle<TResult> | Type contract for result tool bundle. |
ResultUnavailableError | value | typeof ResultUnavailableError | Thrown when the LLM calls the give_up tool, indicating it cannot produce a result that conforms to the required schema. |
ResultValidator | type | ResultValidator<TResult> | Type contract for result validator. |
RetrievedChunk | type | RetrievedChunk | Generic, provider-agnostic retrieval seam. RAG is query-time, so it does NOT fit FilesystemSource (an eager full-dump mount) — a retriever resolves the top matches for a query on demand. Databricks AI Search is the flagship implementation, but this is reusable for any vector store. |
RetrieveOptions | type | RetrieveOptions | Configuration options for retrieve. |
Retriever | type | Retriever | Type contract for retriever. |
RmInput | type | RmInput | Type contract for rm input. |
rmTool | value | (sandbox?: SandboxEnv) => ToolDef<RmInput, void> | Model-callable tool or tool factory for rm. |
Role | type | Role | Type contract for role. |
runAction | value | <TInput, TOutput>(action: ActionDefinition<TInput, TOutput>, host: ActionHost, input?: unknown) => Promise<TOutput> | Validate input, run the action against host, validate + JSON-clone the output. The returned value is always safely serializable (a fresh JSON clone), so callers can persist or transmit it without sharing references. |
RunEvent | type | RunEvent | A workflow event with append-only identity enforced by (runId, eventIndex). |
RunRegistry | type | RunRegistry | Minimal interface for a workflow run registry. Used by durable runtime backends to index and track run statuses. |
RunStore | type | RunStore | Minimal interface for a workflow/event run store. Used by durable runtime backends (Temporal, Cloudflare, etc.) to persist run metadata and events. |
RuntimeModeResolution | type | RuntimeModeResolution | Type contract for runtime mode resolution. |
runWithJobInvocation | value | <T>(context: JobInvocationContext, fn: () => Promise<T> | T) => Promise<T> | T | Runs with job invocation. |
runWithSubmissionContext | value | <T>(context: SubmissionContext, fn: () => Promise<T> | T) => Promise<T> | T | Run fn with context as the ambient submission correlation. |
sameApprovalOperation | value | (grant: ApprovalGrant, input: { toolCallId: string; toolInput: unknown; principal: FabricPrincipal; }) => boolean | Runtime API for same approval operation; the generated signature shows its accepted inputs and return type. |
SandboxAdapterDescriptor | type | SandboxAdapterDescriptor | Adapter expectations: - Every backend must expose the SandboxEnv contract above and map paths into a scoped workspace. - Secrets and provider credentials must stay in adapter-owned environment/config, not model context. - exec should enforce backend-specific command, network, and timeout policy before process launch. - snapshot/restore is optional because not all targets support filesystem or VM snapshots. - Future adapters should be added without changing session/runtime code. Planned backends: local, Docker, Azure Container Apps, Azure Container Instances, AKS, Databricks, E2B, Daytona, C... |
SandboxBackend | type | SandboxBackend | Type contract for sandbox backend. |
SandboxCapabilities | type | SandboxCapabilities | Type contract for sandbox capabilities. |
SandboxContinuityCapabilities | type | SandboxContinuityCapabilities | Type contract for sandbox continuity capabilities. |
SandboxContinuityMode | type | SandboxContinuityMode | Type contract for sandbox continuity mode. |
SandboxEnv | type | SandboxEnv | Type contract for sandbox env. |
SandboxExecOptions | type | SandboxExecOptions | Configuration options for sandbox exec. |
SandboxFactory | type | SandboxFactory | Factory for sandbox. |
SandboxFactoryOptions | type | SandboxFactoryOptions | Configuration options for sandbox factory. |
SandboxFork | type | SandboxFork | Type contract for sandbox fork. |
SandboxOrphanSettlement | type | SandboxOrphanSettlement | Type contract for sandbox orphan settlement. |
SandboxOwnershipLeaseStore | type | SandboxOwnershipLeaseStore | Storage contract for sandbox ownership lease. |
SandboxOwnershipOptions | type | SandboxOwnershipOptions | Configuration options for sandbox ownership. |
SandboxRef | type | SandboxRef | Type contract for sandbox ref. |
SandboxRefDecoder | type | SandboxRefDecoder | Decoder for a SerializedSandboxRef.provider. Returns a SandboxFactory that, when invoked, produces a SandboxEnv connected to the existing remote sandbox identified by providerData. Decoders SHOULD attach without owning the remote sandbox's lifecycle — the returned env's cleanup() should detach, not destroy. |
SandboxSnapshot | type | SandboxSnapshot | Type contract for sandbox snapshot. |
sanitizeObservabilityData | value | (data: JsonObject, additionalSecrets?: string[]) => JsonObject | Runtime API for sanitize observability data; the generated signature shows its accepted inputs and return type. |
sanitizePublicJson | value | <T>(value: T) => T | Runtime API for sanitize public json; the generated signature shows its accepted inputs and return type. |
sanitizePublicText | value | (value: string) => string | Remove credentials and host filesystem locations from caller-visible text. |
schema | value | { string(): Schema<string>; number(): Schema<number>; boolean(): Schema<boolean>; unknown(): Schema<unknown>; enum<const T extends readonly [string, ...string[]]>(values: T): Schema<T[number]>; array<T>(item: Schema<T>): Sch... | Runtime API for schema; the generated signature shows its accepted inputs and return type. |
Schema | type | Schema<T> | Type contract for schema. |
SchemaIssue | type | SchemaIssue | Type contract for schema issue. |
SchemaValidationError | value | typeof SchemaValidationError | Error raised for schema validation failures. |
SearchToolInput | type | SearchToolInput | Type contract for search tool input. |
SearchToolOptions | type | SearchToolOptions | Configuration options for search tool. |
SearchToolResult | type | SearchToolResult | Result returned by search tool. |
secret | value | (name: string) => SecretRef | Runtime API for secret; the generated signature shows its accepted inputs and return type. |
SecretProvider | type | SecretProvider | Provider implementation for secret. |
SecretRef | type | SecretRef | Type contract for secret ref. |
SecretResolutionContext | type | SecretResolutionContext | Type contract for secret resolution context. |
secretResolver | value | (provider: SecretProvider, context?: SecretResolutionContext) => (ref: SecretRef) => Promise<string | undefined> | Adapt a provider to the existing init({ resolveSecret }) callback. |
SerializedFabricError | type | SerializedFabricError | Error raised for serialized fabric failures. |
SerializedSandboxRef | type | SerializedSandboxRef | Cross-process / cross-machine sandbox reference. Created by session.sandboxRef({ portable: true }) and re-attached via attachSandbox(serialized) in a separate process. Each provider string maps to a decoder registered via registerSandboxRefDecoder(). |
serializeFabricError | value | (error: unknown, audience?: "public" | "developer", fallback?: Omit<FabricErrorOptions, "cause">) => SerializedFabricError | Convert any thrown value into the stable public/developer transport shape. |
serializeSandboxRef | value | (ref: SandboxRef, ownerSessionId?: string, tenantId?: string) => SerializedSandboxRef | Serialize an in-process SandboxRef into the cross-process form. Requires the underlying sandbox to implement encodeRef(). Throws SANDBOX_UNAVAILABLE if the backend is in-process-only. |
SessionData | type | SessionData | Type contract for session data. |
SessionEntry | type | SessionEntry<TData> | Type contract for session entry. |
SessionEntryType | type | SessionEntryType | Type contract for session entry type. |
SessionHistory | value | typeof SessionHistory | Runtime API for session history; the generated signature shows its accepted inputs and return type. |
SessionMemory | type | SessionMemory | Type contract for session memory. |
SessionMemoryEntry | type | SessionMemoryEntry<TValue> | Persistent key/value store for facts an agent should remember across sessions — borrower preferences, prior outcomes, learned task history. Distinct from SessionEntry (which is the audit log): memory is for recall, entries are for audit. Memory writes do NOT land in the session log, so they don't pollute prompt context unless the agent explicitly reads them. Tenancy: every operation accepts an optional tenantId. Two tenants with the same key get isolated values. tenantId defaults to the empty string for non-tenant deployments. |
SessionMemoryFilter | type | SessionMemoryFilter | Type contract for session memory filter. |
SessionMemoryGetOptions | type | SessionMemoryGetOptions | Configuration options for session memory get. |
SessionMemorySetInput | type | SessionMemorySetInput<TValue> | Type contract for session memory set input. |
SessionOptions | type | SessionOptions | Configuration options for session. |
SessionStore | type | SessionStore | Storage contract for session. |
SessionSubmissionExecutorOptions | type | SessionSubmissionExecutorOptions | Configuration options for session submission executor. |
setLogger | value | (logger: Logger) => void | Replace the global SDK logger. Call once at startup before any init(). Pass a custom Logger to redirect to your structured logging system. |
ShellOptions | type | ShellOptions | Configuration options for shell. |
shellQuote | value | (value: string) => string | Runtime API for shell quote; the generated signature shows its accepted inputs and return type. |
ShellResult | type | ShellResult | Result returned by shell. |
Skill | type | Skill | Type contract for skill. |
SkillOptions | type | SkillOptions<TResult> | Configuration options for skill. |
slackApprovalNotifier | value | (options: { webhookUrl: string; fetch?: typeof fetch; }) => ApprovalNotifier | Slack incoming-webhook notifier. The webhook URL remains in host configuration, never event data. |
SnapshotPruneOptions | type | SnapshotPruneOptions | Configuration options for snapshot prune. |
SnapshotPruneResult | type | SnapshotPruneResult | Result returned by snapshot prune. |
StateSetter | type | StateSetter<T> | Type contract for state setter. |
StatInput | type | StatInput | Type contract for stat input. |
statTool | value | (sandbox?: SandboxEnv) => ToolDef<StatInput, FileStat> | Model-callable tool or tool factory for stat. |
StdioMcpClient | value | typeof StdioMcpClient | Client implementation for stdio mcp. |
StdioMcpClientOptions | type | StdioMcpClientOptions | Configuration options for stdio mcp client. |
StoredAttachment | type | StoredAttachment | Type contract for stored attachment. |
StreamChunkStore | type | StreamChunkStore | Storage contract for stream chunk. |
StreamChunkWriter | value | typeof StreamChunkWriter | Writer implementation for stream chunk. |
StreamListenerRegistry | value | typeof StreamListenerRegistry | Process-local listener registry shared by store implementations — registration, unsubscribe-and-prune, and error-swallowing notify. |
SttEvent | type | SttEvent | Type contract for stt event. |
SttProvider | type | SttProvider | Provider implementation for stt. |
SttSession | type | SttSession | Type contract for stt session. |
SttSessionOptions | type | SttSessionOptions | Configuration options for stt session. |
SttSessionUsage | type | SttSessionUsage | Type contract for stt session usage. |
SubagentDefinition | type | SubagentDefinition | Type contract for subagent definition. |
SubmissionAbortedError | value | typeof SubmissionAbortedError | Error raised for submission aborted failures. |
SubmissionAdmissionBackend | type | SubmissionAdmissionBackend<Row> | Storage callbacks for admitSubmissionWithBackend. Every callback runs inside the transaction the caller has already opened (or the backend's equivalent atomicity scope). Callbacks may return plain values (synchronous backends) or native Promises — non-native thenables are not supported. |
SubmissionAdmissionRow | type | SubmissionAdmissionRow | The minimal shape admitSubmissionWithBackend needs from a persisted submission row: the transport kind and persisted payload it compares against the incoming admission. payload may be the serialized JSON string or an already-deserialized object (e.g. a Postgres JSONB column). |
SubmissionAttemptRef | type | SubmissionAttemptRef | Type contract for submission attempt ref. |
SubmissionClaimRef | type | SubmissionClaimRef | Type contract for submission claim ref. |
SubmissionContext | type | SubmissionContext | Type contract for submission context. |
SubmissionDurability | type | SubmissionDurability | Type contract for submission durability. |
SubmissionExecuteOptions | type | SubmissionExecuteOptions | Configuration options for submission execute. |
SubmissionExecutor | type | SubmissionExecutor | How the runner touches sessions. execute applies the submission's input to the addressed instance session and resolves with the turn result; everything else is store-level and must not require a live agent. Contract requirements: - execute must be idempotent by submission id (a resumed attempt whose input entry already exists must not append it again). - recordTerminal settles the conversation to a deterministic rest state (unresolved trailing tool calls get explicit interrupted-outcome markers — NEVER re-executed) and appends a terminal advisory. - appendSettlement appends the cano... |
SubmissionInsertRow | type | SubmissionInsertRow | The queued row that admitSubmissionWithBackend writes on first admission. |
SubmissionInspection | type | SubmissionInspection | Coarse persisted-progress classification consumed by reconciliation. |
SubmissionInterruptedError | value | typeof SubmissionInterruptedError | Error raised for submission interrupted failures. |
SubmissionInterruption | type | SubmissionInterruption | Type contract for submission interruption. |
SubmissionPayloadContext | type | SubmissionPayloadContext | Context needed for submission payload validation. Implementations extract these fields from their storage-specific row/document type before calling isSubmissionPayload. |
SubmissionRetryExhaustedError | value | typeof SubmissionRetryExhaustedError | Error raised for submission retry exhausted failures. |
SubmissionRunner | type | SubmissionRunner | Type contract for submission runner. |
SubmissionRunnerOptions | type | SubmissionRunnerOptions | Configuration options for submission runner. |
submissionSessionKey | value | (input: Pick<AgentSubmissionInput, "agent" | "id" | "session">) => string | Store-session FIFO key of a submission (re-exported convenience). |
SubmissionSettledRecord | type | SubmissionSettledRecord | Minimal canonical settlement record for a direct submission. The conversation-stream phase reuses this shape as the durable terminal record a reconnecting waiter observes. |
SubmissionSettlement | type | SubmissionSettlement | Type contract for submission settlement. |
submissionSettlementEntryId | value | (submissionId: string) => string | Deterministic canonical settlement entry id for a submission. |
SubmissionSettlementObligation | type | SubmissionSettlementObligation | Type contract for submission settlement obligation. |
submissionStoreSessionId | value | (input: Pick<AgentSubmissionInput, "agent" | "id" | "session">) => string | The harness identity string (agent:<name>:<id>:<session>) targeted by a submission input. This is the persistentStoreSessionId of the addressed instance session and the per-session FIFO key of the store. |
SubmissionTelemetryEvent | type | SubmissionTelemetryEvent | Type contract for submission telemetry event. |
SubmissionTelemetrySink | type | SubmissionTelemetrySink | Type contract for submission telemetry sink. |
SubmissionTimeoutError | value | typeof SubmissionTimeoutError | Error raised for submission timeout failures. |
TaskOptions | type | TaskOptions<TResult> | Configuration options for task. |
TelemetryExporter | type | TelemetryExporter | Type contract for telemetry exporter. |
TelemetrySpan | type | TelemetrySpan | Type contract for telemetry span. |
tenantCostLimit | value | (tenantId: string, options: TenantCostLimit) => CostLimit | Sugar over CostLimit.perScope + scopeKey + store for the common "per-tenant ceiling per period" pattern. Pick one of perDayUsd, perHourUsd, or perMonthUsd; when multiple are set, the most restrictive (smallest absolute) wins. Scope key convention: tenant:<id>:<period> where <period> is day:YYYY-MM-DD, hour:YYYY-MM-DDTHH:00Z, or month:YYYY-MM. Reset semantics (rollover) are the host's job — call store.reset(scopeKey) from a scheduled task to clear the period total. See the package declarations for an example. |
TenantCostLimit | type | TenantCostLimit | Type contract for tenant cost limit. |
ThinkingLevel | type | ThinkingLevel | Reasoning-effort input level, ordered from least to most thinking. Maps to each provider's native control (Workers AI / OpenAI reasoning_effort, Anthropic thinking.budget_tokens, Gemini thinkingConfig). 'off' (the default when unset) requests no reasoning. Providers that don't support reasoning ignore the level — see ModelMetadata.supportsReasoning. |
toFabricError | value | (error: unknown, fallback: Omit<FabricErrorOptions, "cause">) => FabricError | Error raised for to fabric failures. |
tokenBucketRateLimiter | value | (options: TokenBucketRateLimiterOptions) => RateLimiter | In-memory token-bucket rate limiter. Each key has its own bucket — keys are independent (waiting on one key doesn't block another). Buckets refill continuously at tokensPerSecond. |
TokenBucketRateLimiterOptions | type | TokenBucketRateLimiterOptions | Configuration options for token bucket rate limiter. |
ToolCall | type | ToolCall<TInput> | Type contract for tool call. |
ToolCallResult | type | ToolCallResult<TOutput> | Result returned by tool call. |
ToolContext | type | ToolContext | Type contract for tool context. |
ToolDef | type | ToolDef<TInput, TOutput> | Type contract for tool def. |
ToolEffect | type | ToolEffect | Type contract for tool effect. |
ToolHarness | type | ToolHarness | Type contract for tool harness. |
ToolPolicy | type | ToolPolicy | Type contract for tool policy. |
ToolProgressLogger | type | ToolProgressLogger | Type contract for tool progress logger. |
ToolStep | type | ToolStep | Type contract for tool step. |
toolsToModelSchemas | value | (tools: Iterable<ToolDef>) => ModelToolSchema[] | Runtime API for tools to model schemas; the generated signature shows its accepted inputs and return type. |
toOpenAIMessage | value | (message: ModelMessage) => Record<string, unknown> | Runtime API for to open aimessage; the generated signature shows its accepted inputs and return type. |
toOpenAITool | value | (tool: ModelToolSchema) => Record<string, unknown> | Model-callable tool or tool factory for to open ai. |
TtsProvider | type | TtsProvider | Provider implementation for tts. |
TtsSynthesisOptions | type | TtsSynthesisOptions | Configuration options for tts synthesis. |
TtsSynthesisUsage | type | TtsSynthesisUsage | Type contract for tts synthesis usage. |
TurnJournalState | type | TurnJournalState | Type contract for turn journal state. |
UnifiedInMemoryStore | value | typeof UnifiedInMemoryStore | A unified in-memory store that implements SessionStore, StreamChunkStore, and RunStore. Useful for testing and dev environments where a single object needs to be passed as store, streamChunkStore, and runStore. Backed by separate Maps for each concern so that stream chunks and run data do not pollute session state. |
UnimplementedSandboxEnv | value | typeof UnimplementedSandboxEnv | Runtime API for unimplemented sandbox env; the generated signature shows its accepted inputs and return type. |
unregisterSandbox | value | (refId: string) => void | Mark a registered sandbox as dead so future attach attempts fail. Called from the owner session's cleanup path. |
unregisterSandboxBackendFactory | value | (backend: SandboxBackend) => void | Remove a provider-owned backend factory, primarily for tests and controlled shutdown. |
unregisterSandboxRefDecoder | value | (provider: string) => void | Test/internal: remove a decoder. |
useAgentFinish | value | (run: (context: DynamicAgentFinishContext) => void | Promise<void>) => void | Runtime API for use agent finish; the generated signature shows its accepted inputs and return type. |
useAgentStart | value | (run: (context: DynamicAgentStartContext) => void | Promise<void>) => void | Runtime API for use agent start; the generated signature shows its accepted inputs and return type. |
useDataWriter | value | <T>(name: string, options?: { schema?: Schema<T>; }) => (data: T) => void | Writer implementation for use data. |
useDelivery | value | () => DeliveredMessage | Runtime API for use delivery; the generated signature shows its accepted inputs and return type. |
useDispatchMessage | value | () => (message: DeliveredMessage | string) => Promise<import("./dispatch.js").DispatchReceipt> | Runtime API for use dispatch message; the generated signature shows its accepted inputs and return type. |
useInitialData | value | <T = unknown>() => T | Runtime API for use initial data; the generated signature shows its accepted inputs and return type. |
useInstruction | value | (text: string) => void | Runtime API for use instruction; the generated signature shows its accepted inputs and return type. |
useMcpConnection | value | (definition: McpConnectionDefinition) => void | Runtime API for use mcp connection; the generated signature shows its accepted inputs and return type. |
useModel | value | (model: NonNullable<AgentInit["model"]>, options?: UseModelOptions) => void | Runtime API for use model; the generated signature shows its accepted inputs and return type. |
UseModelOptions | type | UseModelOptions | Configuration options for use model. |
usePersistentState | value | <T>(name: string, defaultValue: T, options?: { schema?: Schema<T>; }) => [T, StateSetter<T>] | Runtime API for use persistent state; the generated signature shows its accepted inputs and return type. |
useResponseFinish | value | (run: DynamicMetadataCallback) => void | Runtime API for use response finish; the generated signature shows its accepted inputs and return type. |
useResponseStart | value | (run: DynamicMetadataCallback) => void | Runtime API for use response start; the generated signature shows its accepted inputs and return type. |
useSandbox | value | (sandbox: SandboxBackend | SandboxFactory | SandboxEnv, options?: UseSandboxOptions) => void | Sandbox adapter for use. |
UseSandboxOptions | type | UseSandboxOptions | Configuration options for use sandbox. |
useSkill | value | (skill: Skill) => void | Runtime API for use skill; the generated signature shows its accepted inputs and return type. |
useSubagent | value | (definition: SubagentDefinition) => void | Runtime API for use subagent; the generated signature shows its accepted inputs and return type. |
useTool | value | <TInput = unknown, TOutput = unknown, THarness extends boolean = false, TDurable extends boolean = false>(tool: ToolDef<TInput, TOutput> | HookToolDefinition<TInput, TOutput, THarness, TDurable>) => void | Model-callable tool or tool factory for use. |
validatePersistentAgentDurability | value | (durability: PersistentAgentDurabilityConfig) => PersistentAgentDurabilityConfig | Validate and normalize a persistent agent's static submission policy. |
validatePersistentInitialData | value | (created: CreatedAgent, initialData: unknown) => JsonValue | Validate and normalize creation data before an instance generation is admitted. |
validatePersistentInstanceContact | value | (uid: string | null | undefined, initialData: unknown) => void | Reject contradictory existing-incarnation and instance-creation inputs. |
validateResult | value | <TResult>(value: unknown, validator?: ResultValidator<TResult>, extraction?: boolean | ResultExtractionOptions) => Promise<TResult> | Result returned by validate. |
VERCEL_AI_GATEWAY_BASE_URL | value | "https://ai-gateway.vercel.sh/v1" | Default base URL for Vercel AI Gateway's OpenAI-compatible Chat Completions endpoint. The gateway accepts the standard OpenAI request body and routes through to the configured provider; switching from OpenAI to the gateway is just a base-URL change. See https://vercel.com/docs/ai-gateway/sdks-and-apis/openai-compat |
vercelAIGateway | value | (options: VercelAIGatewayProviderOptions) => OpenAICompatibleModelProvider | Vercel AI Gateway model provider. The gateway is an OpenAI-compatible HTTP endpoint that brokers between your agent and any of the major model providers (OpenAI, Anthropic, Google, xAI, Groq, etc.) with a single key, observability, caching, and spend controls. Use this provider on any deploy target — Node, Cloudflare Workers, Vercel — to route inference through the gateway. See the package declarations for an example. Returns an OpenAICompatibleModelProvider configured for the gateway — use it anywhere a ModelProvider is accepted. Compatible with fabric-harness's tool-calling, retries,... |
VercelAIGatewayProviderOptions | type | VercelAIGatewayProviderOptions | Configuration options for vercel aigateway provider. |
verifyAttachmentBytes | value | (ref: AttachmentRef, bytes: Uint8Array) => Promise<void> | Verify that bytes match the ref's digest (and declared size), throwing AttachmentStoreError('DIGEST_MISMATCH') otherwise. Every store's put MUST run this check before persisting. |
verifyHmacSha256 | value | (secret: string | Uint8Array, message: Uint8Array, signature: Uint8Array) => Promise<boolean> | Constant-time HMAC-SHA256 verification (via crypto.subtle.verify). |
VertexAIModelProvider | value | typeof VertexAIModelProvider | Provider implementation for vertex aimodel. |
VertexAIProviderOptions | type | VertexAIProviderOptions | Configuration options for vertex aiprovider. |
VirtualSandboxEnv | value | typeof VirtualSandboxEnv | Virtual sandbox backend powered by just-bash. Provides an in-memory filesystem and a bash subset (grep, glob, cat, read, mkdir, rm, ls, echo, etc.) without shelling out to the host. The backend is fast, cheap, safe, and high-concurrency. Selected automatically by the bare @fabric-harness/sdk import when the caller doesn't pass sandbox. Override with 'local', 'docker', a SandboxFactory, or a SandboxEnv when you need real shell access. |
VoiceAudioFormat | type | VoiceAudioFormat | Bidirectional voice / audio streaming surface. fabric-harness ships an OpenAI Realtime implementation; bring-your-own-vendor for Anthropic / Gemini Live / on-prem TTS+ASR pipelines. Audio frames flow in raw bytes — the standard format is PCM 16-bit little-endian at 24kHz mono (OpenAI Realtime default). Telephony bridges (Twilio Media Streams μ-law 8kHz, etc.) resample at the edge. Tool execution is the caller's responsibility: a tool_call event surfaces, the host code runs the tool through whatever governance gates apply (approvals, cost caps, rate limits), then calls `submitToolResult(... |
VoiceConnectOptions | type | VoiceConnectOptions | Configuration options for voice connect. |
VoiceEvent | type | VoiceEvent | Events streamed from a VoiceSession. audio_delta carries raw audio bytes; text_delta and transcript carry text; tool_call and response_done mark structured boundaries; error is fatal. |
VoiceProvider | type | VoiceProvider | Provider implementation for voice. |
VoiceSession | type | VoiceSession | Type contract for voice session. |
VoiceToolResultInput | type | VoiceToolResultInput | Type contract for voice tool result input. |
VoiceWsClientEvent | type | VoiceWsClientEvent | Type contract for voice ws client event. |
VoiceWsClientHandle | type | VoiceWsClientHandle | Type contract for voice ws client handle. |
VoiceWsClientOptions | type | VoiceWsClientOptions | Lightweight WebSocket client for the Node server's WS /sessions/:id/voice endpoint. Server-side bridge owns the provider connection and API keys; this client just streams audio + control messages over WS. Works in browsers and on Node 22+ (uses the global WebSocket). |
webhookApprovalNotifier | value | (options: { url: string; headers?: Record<string, string>; fetch?: typeof fetch; }) => ApprovalNotifier | Runtime API for webhook approval notifier; the generated signature shows its accepted inputs and return type. |
WebhookSubscriptionContext | type | WebhookSubscriptionContext<TPayload> | Generic webhook subscription primitive — wakes an agent on inbound events from any external system (event bus, queue, scheduler, third-party SaaS webhook, your own application's domain events). fabric-harness consumes a JSON payload and dispatches to the user-provided handler. The host event system decides which payloads land here; fabric-harness has no opinion on event taxonomy or producer. |
WebhookSubscriptionDefinition | type | WebhookSubscriptionDefinition<TPayload> | Type contract for webhook subscription definition. |
withConversationProjection | value | (store: SessionStore, streams: ConversationStreamStore, options?: { producerId?: string; onError?: (error: unknown) => void; }) => SessionStore | Wrap a SessionStore so active-path appends are mirrored into an append-only ConversationStreamStore projection (v2 A4). The SessionEntry DAG stays the single source of truth; the stream gives clients offset-based catch-up + live tail. Two rules keep them coherent: 1. Idempotent by entryId — a crash between the DAG write and the stream write is repaired on the next append: the projector diffs the stream tail against the active path and re-emits anything missing. 2. Truncation is explicit — the DAG can branch (fork/replay/ checkpoint-restore rewrite leafId); the stream cannot. W... |
withFilesystemSources | value | (base: SandboxBackend | SandboxFactory | SandboxEnv, sources: MountedSource[]) => SandboxFactory | Runtime API for with filesystem sources; the generated signature shows its accepted inputs and return type. |
WriteFileInput | type | WriteFileInput | Type contract for write file input. |
writeFileTool | value | (sandbox?: SandboxEnv) => ToolDef<WriteFileInput, void> | Model-callable tool or tool factory for write file. |
WsClientCommand | type | WsClientCommand | Type contract for ws client command. |
WsClientHandle | type | WsClientHandle | Type contract for ws client handle. |
WsClientOptions | type | WsClientOptions | Lightweight WebSocket client for the Node server's WS /sessions/:id/ws endpoint. Works in browsers and on Node 22+ (uses the global WebSocket). Does NOT depend on the ws package — that's the server side's optional peer dep. |
@fabric-harness/sdk/strict
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
actionAsTool | value | <TInput, TOutput>(action: ActionDefinition<TInput, TOutput>, host: ActionHost) => ToolDef<unknown, TOutput> | Expose an action to the model as a tool on an agent profile. The tool's JSON schema comes from the action's input schema; execution validates input/output exactly like runAction. |
ActionContext | type | ActionContext<TInput> | Context passed to an action's run. Unlike a tool's execute (a leaf capability invoked by the model), an action receives the harness itself and can orchestrate: prompt models, spawn sessions, call other actions. |
ActionDefinition | type | ActionDefinition<TInput, TOutput> | A named, schema-validated unit of harness work created with defineAction. First-class in v2: registrable on agent profiles as a tool, callable from jobs and agents, evaluable via fh test, and deployable as a platform job task. |
ActionError | value | typeof ActionError | Error raised for action failures. |
ActionHost | type | ActionHost | What an action runs against: the harness entry point (init can prompt models, spawn sessions, and call tools) plus the platform environment. Jobs, agents, and servers all satisfy this — it is the harness slice of FabricContext. |
ActionOptions | type | ActionOptions<TInput, TOutput> | Configuration options for action. |
ActorIdentity | type | ActorIdentity | Type contract for actor identity. |
admitSubmissionWithBackend | value | <Row extends SubmissionAdmissionRow>(input: AgentSubmissionInput, backend: SubmissionAdmissionBackend<Row>) => AgentDispatchAdmission | Promise<AgentDispatchAdmission> | Shared submission admission algorithm for row-oriented backends: dispatch-receipt check → insert-or-ignore → read-back → payload compare (idempotent replay vs. conflict). The message payload is stored as JSON verbatim; payload identity is deep JSON equality, so a backend that normalizes stored JSON (e.g. Postgres JSONB key ordering) still recognizes an exact replay. The caller owns transaction scoping — invoke this inside one transaction and pass callbacks bound to it. When every callback is synchronous the result is returned synchronously, so the algorithm also fits synchronous backends. |
AgentAttemptMarker | type | AgentAttemptMarker | Harness-owned durable evidence that a submission attempt was started and has not yet settled. A coordinator inserts a marker immediately before starting an attempt and deletes it when the attempt settles; reconciliation treats a fresh marker as proof that the attempt may still be running and must not be reconciled as interrupted. |
AgentDefinition | type | AgentDefinition<TInput, TOutput> | Type contract for agent definition. |
AgentDispatchAdmission | type | AgentDispatchAdmission | Type contract for agent dispatch admission. |
AgentDispatchReceipt | type | AgentDispatchReceipt | Type contract for agent dispatch receipt. |
AgentDispatchRequest | type | AgentDispatchRequest | Async delivery request to a persistent agent instance + session. |
AgentEvent | type | AgentEvent | Type contract for agent event. |
AgentEventBase | type | AgentEventBase | Common envelope shared by every event variant. |
AgentEventCallback | type | AgentEventCallback | Callback signature accepted by init({ onEvent }), agent.session(id, { onEvent }), and session.prompt(text, { onEvent }). |
AgentEventType | type | "agent_start" | "session_start" | "prompt_start" | "prompt_end" | "turn_start" | "turn_end" | "model_attempt" | "text_delta" | "toolcall_delta" | "submission_queued" | "submission_running" | "submission_recovery" | "submission_settled" | "cost_limit" | "webhook_r... | Type contract for agent event type. |
AgentInit | type | AgentInit | Type contract for agent init. |
AgentLoopRuntime | type | AgentLoopRuntime | Type contract for agent loop runtime. |
AgentMiddleware | type | (context: AgentRunContext<TInput>, next: () => Promise<TOutput>) => Promise<TOutput> | TOutput | Middleware for agent. |
AgentRunContext | type | AgentRunContext<TInput> | Runtime-ready context for finite agents. The default session is initialized lazily. |
AgentSubmission | type | AgentSubmission | Type contract for agent submission. |
AgentSubmissionDurability | type | AgentSubmissionDurability | Type contract for agent submission durability. |
AgentSubmissionInput | type | AgentSubmissionInput | One admitted agent submission — the persisted operational payload for both transports. kind records how the submission arrived ('dispatch' via dispatch(), 'direct' via the agent HTTP route); a dispatch's submissionId is the public dispatchId from its receipt. |
AgentSubmissionStatus | type | AgentSubmissionStatus | Type contract for agent submission status. |
AgentSubmissionStore | type | AgentSubmissionStore | Durable submission lifecycle storage. Stability: the lease method group mirrors the durable-execution engine and is subject to change until 1.0. This applies to every backend equally. |
AgentTriggers | type | AgentTriggers | Type contract for agent triggers. |
aiGateway | value | (options: AIGatewayOptions) => OpenAICompatibleModelProvider | Generic OpenAI-compatible AI gateway helper. Use for any gateway that speaks the OpenAI Chat Completions request/response shape: Helicone, Portkey, LiteLLM (self-hosted), Cloudflare AI Gateway, internal corp proxies, etc. See the package declarations for an example. For Vercel AI Gateway, prefer the vercelAIGateway preset — same factory under the hood with the gateway URL pre-baked. |
AIGatewayOptions | type | AIGatewayOptions | Configuration options for aigateway. |
AnthropicModelProvider | value | typeof AnthropicModelProvider | Provider implementation for anthropic model. |
AnthropicProviderOptions | type | AnthropicProviderOptions | Configuration options for anthropic provider. |
applyEstimatedCost | value | <T extends { costUsd?: number; } | undefined>(modelRef: string | undefined, usage: T) => T | Idempotently populate usage.costUsd from the static price table. Mutates usage and returns it. No-op when: - usage is undefined, - usage.costUsd is already set (provider supplied it directly), - no price row matches modelRef. |
ApprovalCallback | type | ApprovalCallback | Type contract for approval callback. |
ApprovalDecision | type | ApprovalDecision | Type contract for approval decision. |
ApprovalGrant | type | ApprovalGrant | Durable provenance for one approved logical tool operation. A grant may be replayed for the same logical operation after a crash, but must never authorize a different tool call, input, or executing principal. |
approvalGrantFromJson | value | (value: unknown) => ApprovalGrant | undefined | Parse persisted provenance without trusting a partial or malformed object. |
approvalGrantToJson | value | (grant: ApprovalGrant) => JsonObject | Runtime API for approval grant to json; the generated signature shows its accepted inputs and return type. |
approvalInputDigest | value | (input: unknown) => string | Deterministic digest shared by inline and durable approval runtimes. |
ApprovalNotification | type | ApprovalNotification | Type contract for approval notification. |
ApprovalNotificationDeadLetter | type | ApprovalNotificationDeadLetter | Type contract for approval notification dead letter. |
ApprovalNotificationDeliveryStore | type | ApprovalNotificationDeliveryStore | Storage contract for approval notification delivery. |
approvalNotificationFromEvent | value | (event: FabricEvent, baseUrl?: string) => ApprovalNotification | undefined | Runtime API for approval notification from event; the generated signature shows its accepted inputs and return type. |
approvalNotificationHandler | value | (options: ApprovalNotificationHandlerOptions) => FabricEventCallback | Convert approval events into retryable, deduplicated notifications. This callback never throws. |
ApprovalNotificationHandlerOptions | type | ApprovalNotificationHandlerOptions | Configuration options for approval notification handler. |
ApprovalNotificationState | type | ApprovalNotificationState | Type contract for approval notification state. |
ApprovalNotifier | type | ApprovalNotifier | Type contract for approval notifier. |
ApprovalOptions | type | ApprovalOptions | Configuration options for approval. |
ApprovalPolicyRule | type | ApprovalPolicyRule | Per-pattern approval metadata. Lets policy authors route specific tools/commands to a named audience (e.g. 'reviewer', 'compliance-team', 'project-admin'). The audience id is opaque to fabric-harness — host applications map ids to humans via their own identity layer. |
ApprovalRequest | type | ApprovalRequest | Input contract for approval. |
ApprovalResponse | type | ApprovalResponse | Response contract for approval. |
ApprovalRisk | type | ApprovalRisk | Type contract for approval risk. |
ApprovalState | type | ApprovalState | Type contract for approval state. |
approvalStatesFromEntries | value | (sessionId: string, entries: SessionEntry[]) => ApprovalState[] | Runtime API for approval states from entries; the generated signature shows its accepted inputs and return type. |
ApprovalStateStatus | type | ApprovalStateStatus | Type contract for approval state status. |
ApprovalUnavailableStrategy | type | ApprovalUnavailableStrategy | Type contract for approval unavailable strategy. |
ApprovalVote | type | ApprovalVote | Type contract for approval vote. |
ArtifactCreateOptions | type | ArtifactCreateOptions | Configuration options for artifact create. |
ArtifactRef | type | ArtifactRef | Type contract for artifact ref. |
assertEnforceableNetworkPolicy | value | (policy: CapabilityPolicy | undefined, sandbox: SandboxEnv | Pick<SandboxCapabilities, "network" | "networkEnforcement" | "networkBoundary"> | undefined, requirement?: NetworkEnforcementRequirement) => void | Refuse production network policy when it can be bypassed by code in the sandbox. This validates an operator assertion; the named network boundary must still be provisioned by Docker, Kubernetes, or the cloud provider. |
attachmentDigest | value | (bytes: Uint8Array) => Promise<string> | Lowercase hex SHA-256 of the bytes (WebCrypto). |
AttachmentLimitError | value | typeof AttachmentLimitError | Error raised for attachment limit failures. |
AttachmentPutInput | type | AttachmentPutInput | Type contract for attachment put input. |
AttachmentRef | type | AttachmentRef | Content-addressed descriptor of one stored attachment. |
AttachmentStore | type | AttachmentStore | Durable content-addressed attachment storage. - put is idempotent by (scope, digest) — re-putting the same content succeeds without duplicating storage (the first stored ref metadata is retained). It MUST verify the digest against the bytes and reject a mismatch with AttachmentStoreError('DIGEST_MISMATCH') before writing. - get/getByAttachmentId return null on a miss. - delete removes one stored attachment and throws AttachmentStoreError('NOT_FOUND') when nothing is stored under (scope, digest). |
AttachmentStoreError | value | typeof AttachmentStoreError | Error raised for attachment store failures. |
attachSandbox | value | (ref: SandboxRef | SerializedSandboxRef, options?: AttachSandboxOptions) => SandboxFactory | Build a SandboxFactory that, when invoked, returns an AttachedSandboxEnv delegating to the registered sandbox without owning its lifecycle. Calling cleanup() on the attached env unregisters this attachment but does NOT tear down the underlying sandbox. Pass an in-process SandboxRef to attach within the same process, or a SerializedSandboxRef (from session.sandboxRef({ portable: true })) to rehydrate a sandbox handed off from another process. Cross-process refs require a decoder registered for serialized.provider via registerSandboxRefDecoder(). |
AutonomyMode | type | AutonomyMode | Type contract for autonomy mode. |
AutonomyOptions | type | AutonomyOptions | Configuration options for autonomy. |
AzureOpenAIModelProvider | value | typeof AzureOpenAIModelProvider | Provider implementation for azure open aimodel. |
AzureOpenAIProviderOptions | type | AzureOpenAIProviderOptions | Configuration options for azure open aiprovider. |
BashInput | type | BashInput | Type contract for bash input. |
bashTool | value | (sandbox?: SandboxEnv) => ToolDef<BashInput, ShellResult> | Model-callable tool or tool factory for bash. |
BedrockModelProvider | value | typeof BedrockModelProvider | Provider implementation for bedrock model. |
BedrockProviderOptions | type | BedrockProviderOptions | Configuration options for bedrock provider. |
buildModelMessagesFromHistory | value | (data: SessionData | undefined, role?: Role) => ModelMessage[] | Runtime API for build model messages from history; the generated signature shows its accepted inputs and return type. |
buildResultFollowUpPrompt | value | () => string | Follow-up prompt sent when the LLM ends a turn without calling finish or give_up. |
buildResultFooter | value | () => string | Footer appended to user prompts/skill bodies when a result schema is set. |
buildResultRetryPrompt | value | (error: unknown, extraction?: boolean | ResultExtractionOptions) => string | Runtime API for build result retry prompt; the generated signature shows its accepted inputs and return type. |
BUILTIN_BASH_MAX_BYTES | value | number | Constant defining builtin bash max bytes. |
BUILTIN_BASH_MAX_LINES | value | 2000 | Constant defining builtin bash max lines. |
BUILTIN_GLOB_MAX_RESULTS | value | 1000 | Constant defining builtin glob max results. |
BUILTIN_GREP_MAX_LINE_LENGTH | value | 500 | Constant defining builtin grep max line length. |
BUILTIN_GREP_MAX_MATCHES | value | 100 | Constant defining builtin grep max matches. |
BUILTIN_READ_MAX_BYTES | value | number | Constant defining builtin read max bytes. |
BUILTIN_READ_MAX_LINES | value | 2000 | Public built-in tool limits; documentation and tests consume these constants. |
BuiltinFileTool | type | BuiltinFileTool | Model-callable tool or tool factory for builtin file. |
BuiltinTool | type | BuiltinTool | Model-callable tool or tool factory for builtin. |
bytesToHex | value | (bytes: Uint8Array) => string | Runtime API for bytes to hex; the generated signature shows its accepted inputs and return type. |
CapabilityPolicy | type | CapabilityPolicy | Type contract for capability policy. |
CartesiaSttProvider | value | typeof CartesiaSttProvider | Provider implementation for cartesia stt. |
CartesiaSttProviderOptions | type | CartesiaSttProviderOptions | Configuration options for cartesia stt provider. |
CartesiaTtsProvider | value | typeof CartesiaTtsProvider | Provider implementation for cartesia tts. |
CartesiaTtsProviderOptions | type | CartesiaTtsProviderOptions | Configuration options for cartesia tts provider. |
chainSecretProviders | value | (...providers: Array<SecretProvider | undefined>) => SecretProvider | Resolve from providers in order; errors fail closed instead of falling through. |
Channel | type | Channel | Type contract for channel. |
ChannelContext | type | ChannelContext | Type contract for channel context. |
ChannelDispatch | type | ChannelDispatch | Type contract for channel dispatch. |
ChannelDispatchRequest | type | ChannelDispatchRequest | Input contract for channel dispatch. |
ChannelRoute | type | ChannelRoute | Channels turn platform webhooks (Slack, GitHub, …) into agent dispatches. Handlers are written against the Web Request/Response API and crypto.subtle, so the same channel runs on Node and Cloudflare. A channel is a stateless route container plus a conversation-id (de)serializer — session continuity falls out of the key (same thread → same key → same session). |
CheckpointCreateOptions | type | CheckpointCreateOptions | Configuration options for checkpoint create. |
CheckpointRestoreOptions | type | CheckpointRestoreOptions | Configuration options for checkpoint restore. |
CheckpointResult | type | CheckpointResult | Result returned by checkpoint. |
clampCommandTimeout | value | (timeout: number | undefined, policy?: CapabilityPolicy) => number | undefined | Runtime API for clamp command timeout; the generated signature shows its accepted inputs and return type. |
clampReadLimit | value | (limit: number | undefined) => number | Runtime API for clamp read limit; the generated signature shows its accepted inputs and return type. |
classifySubmissionState | value | (path: readonly SessionEntry[], submissionId: string) => SubmissionInspection | Classify how far a persisted submission input progressed. - absent — the input entry never landed in session history: the attempt crashed before applying it. Safe to requeue for a clean first attempt. - completed — finished work: a canonical settlement entry exists, an assistant response follows the input with no unresolved trailing tool batch, or a later user input shows the conversation moved on. Settle as success; never retry (retrying completed work is the one unrecoverable corruption). - continuable — the trailing turn carries unresolved tool calls. The next session.prompt() re... |
CohereModelProvider | value | typeof CohereModelProvider | Provider implementation for cohere model. |
CohereProviderOptions | type | CohereProviderOptions | Configuration options for cohere provider. |
combineSubmissionTelemetrySinks | value | (...sinks: SubmissionTelemetrySink[]) => SubmissionTelemetrySink | Fan one event out to several sinks. |
Command | type | Command<TInput> | Type contract for command. |
CommandEnvValue | type | CommandEnvValue | Type contract for command env value. |
CommandPolicy | type | CommandPolicy | Type contract for command policy. |
CommandToolInput | type | CommandToolInput | Type contract for command tool input. |
CommandToolOptions | type | CommandToolOptions | Configuration options for command tool. |
CompactionOptions | type | CompactionOptions | Configuration options for compaction. |
CompactionResult | type | CompactionResult | Result returned by compaction. |
configureDispatchRuntime | value | (runtime: DispatchRuntime) => void | Configure the ambient dispatch queue used by dispatch. |
configureJobInvocationRuntime | value | (next: JobInvocationRuntime) => void | Runtime API for configure job invocation runtime; the generated signature shows its accepted inputs and return type. |
connectFabricVoice | value | (options: VoiceWsClientOptions) => VoiceWsClientHandle | Runtime API for connect fabric voice; the generated signature shows its accepted inputs and return type. |
connectFabricWs | value | (options: WsClientOptions) => WsClientHandle | Runtime API for connect fabric ws; the generated signature shows its accepted inputs and return type. |
connectMcpServer | value | (name: string, options: McpServerOptions) => Promise<McpServerConnection> | Runtime API for connect mcp server; the generated signature shows its accepted inputs and return type. |
consoleTelemetryExporter | value | (prefix?: string) => TelemetryExporter | Telemetry exporter that writes spans through the SDK logger (default console-backed). Useful for local development and as a fallback when no OpenTelemetry collector is wired up. Use openTelemetryExporter or langfuseExporter for production. |
ContextBudget | type | ContextBudget | Type contract for context budget. |
ContextBudgetOptions | type | ContextBudgetOptions | Configuration options for context budget. |
CONVERSATION_STREAM_DEFAULT_READ_LIMIT | value | 100 | Constant defining conversation stream default read limit. |
CONVERSATION_STREAM_FORMAT_VERSION | value | 1 | Constant defining conversation stream format version. |
CONVERSATION_STREAM_MAX_READ_LIMIT | value | 1000 | Constant defining conversation stream max read limit. |
ConversationFoldCheckpoint | type | ConversationFoldCheckpoint | Disposable durable cache of a folded conversation at one committed batch. |
conversationKey | value | (provider: string, version: string, ...segments: string[]) => string | Runtime API for conversation key; the generated signature shows its accepted inputs and return type. |
ConversationMessage | type | ConversationMessage | Type contract for conversation message. |
ConversationMessageDisplay | type | ConversationMessageDisplay | Type contract for conversation message display. |
ConversationMessagePurpose | type | ConversationMessagePurpose | Type contract for conversation message purpose. |
ConversationMessageRole | type | ConversationMessageRole | Type contract for conversation message role. |
ConversationPart | type | ConversationPart | Type contract for conversation part. |
ConversationProducerClaim | type | ConversationProducerClaim | Type contract for conversation producer claim. |
ConversationProjector | value | typeof ConversationProjector | Runtime API for conversation projector; the generated signature shows its accepted inputs and return type. |
ConversationReply | type | ConversationReply | Type contract for conversation reply. |
ConversationSettlement | type | ConversationSettlement | Type contract for conversation settlement. |
ConversationSnapshot | type | ConversationSnapshot | Type contract for conversation snapshot. |
ConversationStreamAppendInput | type | ConversationStreamAppendInput | Type contract for conversation stream append input. |
ConversationStreamBatch | type | ConversationStreamBatch | Type contract for conversation stream batch. |
ConversationStreamIdentity | type | ConversationStreamIdentity | Type contract for conversation stream identity. |
ConversationStreamMeta | type | ConversationStreamMeta | Type contract for conversation stream meta. |
conversationStreamPath | value | (storeSessionId: string) => string | Stream path for a session's conversation projection. |
ConversationStreamReadResult | type | ConversationStreamReadResult | Result returned by conversation stream read. |
ConversationStreamRecord | type | ConversationStreamRecord | Append-only conversation stream — the durable, offset-addressable projection of a session's active path (v2 migration, phase A4). The SessionEntry DAG remains the single source of truth for model context; this stream exists so clients can read a conversation with offsets (catch-up + live tail), across processes, without count-based replay. The projection appends one record per active-path entry, and — because the DAG can branch (fork/replay/checkpoint-restore) while a stream cannot — an explicit truncated record whenever the active path rewinds, paired with a producer-epoch bump so stale... |
ConversationStreamStore | type | ConversationStreamStore | Durable append-only conversation stream storage. Batch atomicity is a hard contract requirement: every record in an append must be persisted together under one offset, all-or-nothing. First-party adapters satisfy this by serializing the batch into a single row/document write; an adapter that splits records across non-atomic writes violates the contract. Producer fencing: acquireProducer bumps the producer epoch; appends carrying a stale epoch are rejected. The (path, producerId, epoch, sequence) uniqueness makes redelivered appends idempotent — a retried append with the same coo... |
ConversationStreamStoreError | value | typeof ConversationStreamStoreError | Error raised for conversation stream store failures. |
CostBudgetStore | type | CostBudgetStore | Async store for cross-process spend aggregation. Pair with CostLimit.scopeKey + CostLimit.perScope to enforce a budget that survives process restarts — "tenant:acme spends ≤ $50 today" or "company-wide ≤ $100 this hour". Built-in implementations: - inMemoryCostBudgetStore() — process-local; default. - @fabric-harness/node exposes postgresCostBudgetStore({ pool }). |
CostBudgetTracker | value | typeof CostBudgetTracker | Tracks cumulative session spend. Cheap to construct; one per session. |
CostLimit | type | CostLimit | Type contract for cost limit. |
CostLimitContext | type | CostLimitContext | Type contract for cost limit context. |
CostLimitExceededError | value | typeof CostLimitExceededError | Error raised for cost limit exceeded failures. |
createAgent | value | <TEnv = Record<string, string>>(initialize: ((context: PersistentAgentContext<TEnv>) => PersistentAgentConfig | Promise<PersistentAgentConfig>) | DynamicAgentFunction<TEnv>, definition?: PersistentAgentConfig) => CreatedAgent<TEnv> | Define a persistent, URL-addressable agent. Files in .fabricharness/agents/ default-export createAgent(...); the runtime resolves a fresh config per interaction and keeps sessions across direct prompts and dispatched inputs. |
createApprovalGrant | value | (input: { approvalId: string; toolCallId: string; toolInput: unknown; principal: FabricPrincipal; response: ApprovalResponse; createdAt: string; ttlSeconds?: number; decidedAt?: string; }) => ApprovalGrant | Creates approval grant. |
createApprovalGrantForState | value | (state: ApprovalState, response: ApprovalResponse) => ApprovalGrant | undefined | Build the terminal grant after a store reaches approval quorum. |
createAttachmentRef | value | (input: { id: string; mimeType: string; bytes: Uint8Array; filename?: string; }) => Promise<AttachmentRef> | Build an AttachmentRef for the given bytes, computing the SHA-256 digest via WebCrypto (crypto.subtle) so the SDK stays runtime-agnostic. |
createBuiltinTools | value | (sandbox: SandboxEnv, packagedSkills?: Record<string, PackagedSkillDirectory>) => BuiltinTool[] | Creates builtin tools. |
createCommandTools | value | (commands: Command[], options?: CommandToolOptions) => ToolDef<CommandToolInput, ShellResult>[] | Creates command tools. |
createConsoleLogger | value | (level?: LogLevel) => Logger | Build a Console-backed logger with an explicit level. Useful for tests that want to capture or silence SDK output without touching globals. |
CreatedAgent | type | CreatedAgent<TEnv> | A persistent, addressable agent created with createAgent. Distinct from a finite defineAgent({ run }) job: it has no run — the initializer returns configuration, and the runtime maintains sessions across interactions. |
createDirectAgentSubmissionInput | value | (options: { agent: string; id: string; session?: string; message: DeliveredMessage; initialData?: JsonValue; uid?: string | null; joinWhileBusy?: boolean; tenantId?: string; actor?: FabricActor; durability?: AgentSubmissionDurability; }) => AgentSubmissionInput | Mint a direct-prompt submission input with a fresh submission id. |
createDispatchAgentSubmissionInput | value | (dispatch: DispatchInput) => AgentSubmissionInput | Map a DispatchInput onto the persisted submission input shape. |
createErrorReference | value | (now?: number) => string | Mint an opaque, sortable correlation reference for one transported error. |
createFabricContext | value | <TPayload extends JsonObject = JsonObject>(payload: TPayload) => FabricContext<TPayload> | Creates fabric context. |
createFabricFs | value | (sandboxLike: SandboxEnv | Promise<SandboxEnv> | (() => SandboxEnv | Promise<SandboxEnv>)) => FabricFs | Adapt a sandbox into the public filesystem convenience surface. |
createFileTools | value | (sandbox: SandboxEnv, packagedSkills?: Record<string, PackagedSkillDirectory>) => BuiltinFileTool[] | Creates file tools. |
createMcpAuthorizationCodeAuth | value | (options: McpAuthorizationCodeOptions) => OAuthClientProvider | Authorization-code + PKCE provider; the MCP SDK refreshes stored tokens automatically. |
createMcpClientCredentialsAuth | value | (options: McpClientCredentialsOptions) => OAuthClientProvider | OAuth client-credentials provider with MCP SDK token refresh handling. |
createMcpTools | value | (client: McpClientLike, options?: CreateMcpToolsOptions) => Promise<ToolDef[]> | Creates mcp tools. |
CreateMcpToolsOptions | type | CreateMcpToolsOptions | Configuration options for create mcp tools. |
createObservabilityObserver | value | (options: ObservabilityObserverOptions) => FabricEventCallback | Create a fail-open event observer suitable for Braintrust, Sentry, Jetty, or a custom sink. |
createObservabilityRecord | value | (event: FabricEvent, options: Pick<ObservabilityObserverOptions, "integration" | "correlation" | "captureData" | "additionalSecrets">) => FabricObservabilityRecord | Convert a Fabric event into a vendor-neutral, low-cardinality record. |
createOperationalMetricsCollector | value | () => OperationalMetricsCollector | Low-cardinality operational metrics collector suitable for OTel/Prometheus bridging. |
createPiAgentLoopRuntime | value | (options?: PiAgentLoopRuntimeOptions) => PiAgentLoopRuntime | Creates pi agent loop runtime. |
createRemoteSandboxEnv | value | (api: RemoteSandboxApi, options?: RemoteSandboxOptions) => SandboxEnv | Wrap a provider-owned remote sandbox client in Fabric's SandboxEnv contract. Provider credentials and SDK objects remain outside model context/history; Fabric only sees the narrow file/shell/snapshot API exposed here. |
createResultTools | value | <TResult>(validator: ResultValidator<TResult>) => ResultToolBundle<TResult> | Produce the per-call finish and give_up tool pair for a given ResultValidator. - finish's parameters are a generic JSON Schema object because we can't derive a precise schema from ResultValidator. The validator's safeParse handles actual validation. - First successful finish (or give_up) call wins. Subsequent calls return an error tool result rather than throwing, to keep the conversation transcript natural. |
createSandboxEnv | value | (options?: SandboxFactoryOptions) => Promise<SandboxEnv> | Creates sandbox env. |
createScopedSandboxEnv | value | (sandbox: SandboxEnv, cwd?: string) => SandboxEnv | Return a view of a sandbox with a narrower default cwd. Relative file paths and shell cwd values are resolved from this scoped cwd while the underlying sandbox still enforces its workspace boundary. |
createSearchTool | value | (retriever: Retriever, options?: SearchToolOptions) => ToolDef<SearchToolInput, SearchToolResult> | Exposes a Retriever to the model as a search tool. The tool is read-only; wrap it with a governance decorator to stamp lineage or route approvals. |
createStdioMcpClient | value | (options: StdioMcpClientOptions) => StdioMcpClient | Creates stdio mcp client. |
createSubmissionRunner | value | (options: SubmissionRunnerOptions) => SubmissionRunner | Creates submission runner. |
createVirtualSandboxEnv | value | (options?: SandboxFactoryOptions & { initialFiles?: Record<string, string | Uint8Array>; }) => VirtualSandboxEnv | Creates virtual sandbox env. |
CredentialMissingStrategy | type | "fail" | Type contract for credential missing strategy. |
currentJobInvocation | value | () => JobInvocationContext | undefined | Runtime API for current job invocation; the generated signature shows its accepted inputs and return type. |
currentSubmissionContext | value | () => SubmissionContext | undefined | The submission owning the current execution, or undefined outside one. |
DeepgramSttProvider | value | typeof DeepgramSttProvider | Provider implementation for deepgram stt. |
DeepgramSttProviderOptions | type | DeepgramSttProviderOptions | Configuration options for deepgram stt provider. |
DEFAULT_HEADLESS_PREAMBLE | value | "You are running in headless autonomous mode (background-agent mode) with no human operator assumed. Work autonomously: Do not ask clarifying questions or wait for in-band user input. Make safe, reasonable assumptions when possible; if blocked by missing credentials, unavailab... | Constant defining default headless preamble. |
defaultLoopRuntime | value | NativeLoopRuntime | Runtime API for default loop runtime; the generated signature shows its accepted inputs and return type. |
defaultModelProvider | value | MockModelProvider | Provider implementation for default model. |
defaultSessionStore | value | InMemorySessionStore | Storage contract for default session. |
defineAction | value | <TInput = unknown, TOutput = unknown>(options: ActionOptions<TInput, TOutput>) => ActionDefinition<TInput, TOutput> | Define an action — the harness-context counterpart to defineTool. A tool is a leaf capability the model calls; an action holds the harness (context.init) and can prompt, spawn sessions, and compose other work. Input/output use the harness schema builders and are validated on every runAction call; outputs must be JSON-serializable. |
defineAgent | value | <TInput = JsonObject, TOutput = unknown>(definition: AgentDefinition<TInput, TOutput>) => DefinedAgent<TInput, TOutput> | No-defaults finite-agent builder with lazy default-session helpers. The runtime admits these finite definitions through its job/run protocol, but authors define an agent. Use createAgent for a persistent, URL-addressable agent whose sessions span multiple submissions. |
defineChannel | value | (channel: Channel) => Channel | Validates and brands a channel's routes. |
defineCommand | value | <TInput = CommandToolInput>(name: string, options?: Omit<Command<TInput>, "name">) => Command<TInput> | Defines command. |
DefinedAgent | type | DefinedAgent<TInput, TOutput> | Type contract for defined agent. |
defineMcpConnection | value | (definition: McpConnectionDefinition) => McpConnectionDefinition | Defines mcp connection. |
defineSubagent | value | (definition: SubagentDefinition) => SubagentDefinition | Defines subagent. |
defineTool | value | { <TInput = unknown, TOutput = unknown>(tool: ToolDef<TInput, TOutput>): ToolDef<TInput, TOutput>; <TInput = unknown, TOutput = unknown, THarness extends boolean = false, TDurable extends boolean = false>(tool: HookToolDefinition<TInput, TOutput... | Defines tool. |
defineWebhookSubscription | value | <TPayload = JsonObject>(definition: WebhookSubscriptionDefinition<TPayload>) => WebhookSubscriptionDefinition<TPayload> | Helper that returns the definition unchanged. Useful for type inference and to keep agent files declarative. See the package declarations for an example. |
DeletionCompletionRecord | type | DeletionCompletionRecord | Type contract for deletion completion record. |
DeliveredAttachment | type | DeliveredAttachment | One attachment on a kind: 'user' message. Today the only supported attachment is an image, carried either inline (data, base64) or as a durable content-addressed reference (ref) once an attachment store is configured — admission materializes inline bytes into refs. An attachment must carry data or ref (or both, transiently during materialization). |
DeliveredAttachmentRef | type | DeliveredAttachmentRef | Durable reference to attachment bytes in an attachment store. |
DeliveredMessage | type | DeliveredMessage | DeliveredMessage — the single unified input shape for everything that enters a persistent agent's session: direct HTTP prompts, dispatch, channels/webhooks, Databricks events, SDK clients, and tests. kind: 'user' is a direct user talking to the assistant (1:1 chat surface), optionally carrying attachments. kind: 'signal' models everything beyond that direct exchange — a Slack thread or a Lakeflow job event is activity the agent observes, not the assistant's own user speaking. Sender identity and structured metadata go in attributes; the message itself in body. Signals render into mo... |
deliveredSignalToEntryData | value | (message: Extract<DeliveredMessage, { kind: "signal"; }>) => SignalEntryData | Map a signal-kind message onto the persisted signal entry's data shape. |
deriveCompactionDefaults | value | (input: { contextWindowTokens: number; maxOutputTokens?: number; }) => { reserveTokens: number; keepRecentTokens: number; } | Compute model-aware compaction defaults. Reserve is capped at the model's max output because reserving more than the model can emit in one turn wastes context; the preserved tail stays flat because recent-context fidelity depends on the active work, not on the model's total window size. |
dispatch | value | { (agent: CreatedAgent, request: AgentDispatchRequest): Promise<DispatchReceipt>; (request: NamedAgentDispatchRequest): Promise<DispatchReceipt>; } | Runtime API for dispatch; the generated signature shows its accepted inputs and return type. |
DispatchInput | type | DispatchInput | Internal enqueued form, carrying correlation + isolation metadata. |
DispatchProcessor | type | DispatchProcessor | Consumes enqueued dispatches and applies them to an instance session. |
DispatchQueue | type | DispatchQueue | Admission queue for dispatches. The default is in-process; durable backends implement the same shape. |
DispatchReceipt | type | DispatchReceipt | Acceptance confirmation for an enqueued dispatch. |
DockerSandboxEnv | value | typeof DockerSandboxEnv | Runtime API for docker sandbox env; the generated signature shows its accepted inputs and return type. |
DockerSandboxOptions | type | DockerSandboxOptions | Configuration options for docker sandbox. |
DURABILITY_DEFAULT_MAX_ATTEMPTS | value | 10 | Default maximum total attempts before terminalization. |
DURABILITY_DEFAULT_TIMEOUT_MS | value | 3600000 | Default submission timeout in milliseconds (one hour). |
DurableSessionRuntime | type | DurableSessionRuntime | Structural delegate for durable session execution. When init() is given a sessionRuntime factory that produces one of these, the SDK's session calls (prompt, task, shell, checkpoint.*) are routed through the runtime instead of executing inline. This is the seam for Temporal workflows, external orchestration runtimes, or test fakes. mount, history, artifact, and compact remain SDK-local concerns and are not delegated — they operate against the local session store. |
DurableSessionRuntimeFactory | type | DurableSessionRuntimeFactory | Factory for durable session runtime. |
DynamicAgentExecutionDescriptor | type | DynamicAgentExecutionDescriptor | JSON-safe identity required to re-render a persistent dynamic agent at a trusted durable-runtime boundary. Hook functions, tool implementations, credentials, and resolved MCP connections are deliberately excluded. |
DynamicAgentFinishContext | type | DynamicAgentFinishContext | Type contract for dynamic agent finish context. |
DynamicAgentFunction | type | DynamicAgentFunction<TEnv> | Type contract for dynamic agent function. |
DynamicAgentProps | type | DynamicAgentProps<TEnv> | Dynamic persistent-agent composition. The runtime keeps Fabric's builders, policies, persistence contracts, and backend-neutral types while allowing capabilities to evolve per interaction. |
DynamicAgentRefreshInput | type | DynamicAgentRefreshInput | Type contract for dynamic agent refresh input. |
DynamicAgentRenderOptions | type | DynamicAgentRenderOptions | Configuration options for dynamic agent render. |
DynamicAgentResponse | type | DynamicAgentResponse | Response contract for dynamic agent. |
DynamicAgentRuntime | type | DynamicAgentRuntime | Type contract for dynamic agent runtime. |
DynamicAgentStartContext | type | DynamicAgentStartContext | Type contract for dynamic agent start context. |
DynamicLifecycleContext | type | DynamicLifecycleContext | Type contract for dynamic lifecycle context. |
DynamicMetadataCallback | type | DynamicMetadataCallback | Type contract for dynamic metadata callback. |
editFileTool | value | (sandbox?: SandboxEnv) => ToolDef<EditInput, void> | Model-callable tool or tool factory for edit file. |
EditInput | type | EditInput | Type contract for edit input. |
ElevenLabsTtsProvider | value | typeof ElevenLabsTtsProvider | Provider implementation for eleven labs tts. |
ElevenLabsTtsProviderOptions | type | ElevenLabsTtsProviderOptions | Configuration options for eleven labs tts provider. |
EmbeddingProvider | type | EmbeddingProvider | Embeddings seam. Feeds self-managed-embedding vector indexes (embed the query → query vector) and any bring-your-own retrieval pipeline. Returns one vector per input text, order-preserving. |
emitOpenTelemetrySpan | value | (tracer: Tracer, span: TelemetrySpan, attributes?: Record<string, string | number | boolean>, conventions?: "fabric" | "foundry") => Span | Runtime API for emit open telemetry span; the generated signature shows its accepted inputs and return type. |
emitSubmissionTelemetry | value | (sink: SubmissionTelemetrySink | undefined, event: SubmissionTelemetryEvent, onError?: (error: unknown) => void) => void | Deliver an event to a sink, swallowing (and reporting) sink failures. |
EmptySandboxEnv | value | typeof EmptySandboxEnv | Runtime API for empty sandbox env; the generated signature shows its accepted inputs and return type. |
enqueueDispatch | value | (queue: DispatchQueue, request: NamedAgentDispatchRequest, extra?: { tenantId?: string; actor?: FabricActor; dispatchId?: string; }) => Promise<DispatchReceipt> | Validate + normalize a named request and enqueue it, generating the dispatch id. |
ensurePersistentInstanceIdentity | value | (options: { store: SessionStore; agentName: string; instanceId: string; uid?: string | null; tenantId?: string; actor?: FabricActor; }) => Promise<PersistentInstanceIdentity> | Atomically resolve or create one tenant-scoped persistent instance generation. |
entryToTelemetrySpan | value | (sessionId: string, entry: SessionEntry) => TelemetrySpan | undefined | Runtime API for entry to telemetry span; the generated signature shows its accepted inputs and return type. |
environmentSecretProvider | value | (options?: EnvironmentSecretProviderOptions) => SecretProvider | Runtime-only environment provider with optional prefix and explicit allowlist. |
EnvironmentSecretProviderOptions | type | EnvironmentSecretProviderOptions | Configuration options for environment secret provider. |
estimateCostUsd | value | (modelRef: string, usage: ModelPricingUsage) => number | Estimate USD cost for a single model call. Returns 0 when no row matches modelRef — callers should treat 0 as "unknown" and not overwrite an existing costUsd from the provider. |
estimateModelMessagesTokens | value | (messages: ModelMessage[]) => number | Runtime API for estimate model messages tokens; the generated signature shows its accepted inputs and return type. |
estimateSessionEntriesTokens | value | (entries: SessionEntry[]) => number | Runtime API for estimate session entries tokens; the generated signature shows its accepted inputs and return type. |
estimateTextTokens | value | (text: string) => number | Runtime API for estimate text tokens; the generated signature shows its accepted inputs and return type. |
evaluateCommandPolicy | value | (command: string | undefined, policy?: CapabilityPolicy) => PolicyDecision | Runtime API for evaluate command policy; the generated signature shows its accepted inputs and return type. |
evaluateContextBudget | value | (messages: ModelMessage[], options?: ContextBudgetOptions) => ContextBudget | Runtime API for evaluate context budget; the generated signature shows its accepted inputs and return type. |
evaluateNetworkPolicy | value | (input: string | URL | Request, policy?: CapabilityPolicy) => PolicyDecision | Evaluate a URL or Request against the configured network policy. Returns { allowed: true } when the request is permitted, otherwise a denial with the reason and matched pattern. |
evaluateOperationalSlos | value | (snapshot: OperationalMetricsSnapshot, targets: OperationalSloTargets) => OperationalSloEvaluation | Runtime API for evaluate operational slos; the generated signature shows its accepted inputs and return type. |
evaluateToolCallPolicy | value | (call: ToolCall, policy?: CapabilityPolicy) => PolicyDecision | Runtime API for evaluate tool call policy; the generated signature shows its accepted inputs and return type. |
eventToTelemetrySpan | value | (event: FabricEvent) => TelemetrySpan | undefined | Runtime API for event to telemetry span; the generated signature shows its accepted inputs and return type. |
execSandboxCommand | value | (sandbox: SandboxEnv, command: string, options?: SandboxExecOptions) => Promise<ShellResult> | Reject promptly on cancellation even when a remote provider cannot cancel its command. The underlying promise remains observed and reports its final, redacted settlement through onOrphanSettled. |
ExistsInput | type | ExistsInput | Type contract for exists input. |
existsTool | value | (sandbox?: SandboxEnv) => ToolDef<ExistsInput, boolean> | Model-callable tool or tool factory for exists. |
extractResultValue | value | (value: unknown, extraction?: boolean | ResultExtractionOptions) => unknown | Runtime API for extract result value; the generated signature shows its accepted inputs and return type. |
FABRIC_OPERATIONAL_METRICS | value | { readonly requestLatencyMs: "fabric_harness_request_latency_ms"; readonly submissionDurationMs: "fabric_harness_submission_duration_ms"; readonly queueAgeMs: "fabric_harness_queue_age_ms"; readonly errorsTotal: "fabric_harness_errors_total"; readonly approvalWaitMs: "fab... | Constant defining fabric operational metrics. |
FabricActor | type | FabricActor | Type contract for fabric actor. |
FabricAgent | type | FabricAgent | Type contract for fabric agent. |
FabricContext | type | FabricContext<TPayload> | Type contract for fabric context. |
FabricError | value | typeof FabricError | Error raised for fabric failures. |
FabricErrorCode | type | FabricErrorCode | Type contract for fabric error code. |
FabricErrorOptions | type | FabricErrorOptions | Configuration options for fabric error. |
FabricEvent | type | FabricEvent<TData> | Type contract for fabric event. |
FabricEventCallback | type | FabricEventCallback | Type contract for fabric event callback. |
FabricEventType | type | FabricEventType | Type contract for fabric event type. |
FabricFs | type | FabricFs | Out-of-band filesystem surface for a session sandbox. These operations do not write to conversation history and are intended for host-side plumbing: staging files, collecting artifacts, and preparing scratch space. If the model should reason about a file, prompt it to use the normal read/write/edit tools instead. |
FabricObservabilityRecord | type | FabricObservabilityRecord | Type contract for fabric observability record. |
FabricPrincipal | type | FabricPrincipal | The governed identity a piece of work runs as (v2). Distinct from ActorIdentity (who asked): the principal is what the platform's access control enforces — a human user, a machine service principal, or a hosted app's own identity. ucPrincipal carries the catalog-governance principal name when the platform has one (e.g. Unity Catalog). |
FabricRuntime | type | FabricRuntime | Execution runtime selection. - inline (default): single-process execution. Uses the configured SessionStore (in-memory by default) for history, artifacts, approvals. - stateless: explicit headless / ephemeral mode. No session store, no artifact persistence, no approval waiting. Each invocation is independent. Use for high-volume webhook agents and edge runtimes where state would just be discarded anyway. In production (FABRIC_ENV=production or NODE_ENV=production) this mode must be selected explicitly — inline without an explicit store will warn or fail depending on `FABRIC_ALLO... |
FabricSession | type | FabricSession | Type contract for fabric session. |
FallbackModelProvider | value | typeof FallbackModelProvider | Provider implementation for fallback model. |
FallbackModelProviderOptions | type | FallbackModelProviderOptions | Configuration options for fallback model provider. |
FileStat | type | FileStat | Type contract for file stat. |
FilesystemEntry | type | FilesystemEntry | Type contract for filesystem entry. |
FilesystemPolicy | type | FilesystemPolicy | Type contract for filesystem policy. |
FilesystemSource | type | FilesystemSource | A read-only content source that can be mounted into a sandbox at sandbox-creation time. The agent then has built-in read, glob, and grep tools available over the mounted content — no retrieval pipeline, no embeddings, no vector store required. Sources are intentionally minimal: they yield (path, content) pairs. Implementations decide how to enumerate (eager vs lazy is up to the source author) — the mount step pulls the full set into the sandbox. |
findSubmissionInputIndex | value | (path: readonly SessionEntry[], submissionId: string) => number | Index of the last canonical user or signal input carrying the submission id, or -1. |
findTrailingDanglingToolCalls | value | (path: SessionEntry[]) => SessionEntry[] | Find trailing tool_call entries on the active path that were never settled — no matching tool_result (paired by toolCallId, falling back to tool name) and no subsequent error entry for the same tool. A dangling call means a model turn died (crash/abort) between recording the call and recording its outcome. Left in place it produces an assistant tool_use with no tool_result on resume, which providers reject — the repair path appends synthetic interrupted outcomes for exactly the entries returned here. Conservative by construction: only the window after the last turn boundary (use... |
findTrailingUnfinishedTasks | value | (path: SessionEntry[]) => SessionEntry[] | Trailing task_start entries in the same window with no matching task_end — a subtask that was in flight when the turn died. These do not corrupt model context (task entries are bookkeeping), but settling them keeps UI/audit state coherent. |
formatSchemaIssues | value | (issues: SchemaIssue[]) => string | Runtime API for format schema issues; the generated signature shows its accepted inputs and return type. |
formatStreamOffset | value | (offset: number) => string | Runtime API for format stream offset; the generated signature shows its accepted inputs and return type. |
fumadocsSource | value | (contentRoot: string, options?: { name?: string; stripFrontmatter?: boolean; include?: (relativePath: string) => boolean; }) => FilesystemSource | Mount a local Fumadocs content directory as a knowledge base. Strips MDX frontmatter by default for cleaner agent context. For a published Fumadocs site, fetch its llms.txt / sitemap and pass the URLs to httpFilesystemSource. |
GeminiModelProvider | value | typeof GeminiModelProvider | Provider implementation for gemini model. |
GeminiProviderOptions | type | GeminiProviderOptions | Configuration options for gemini provider. |
GeneralSubagent | value | SubagentDefinition | Runtime API for general subagent; the generated signature shows its accepted inputs and return type. |
generateAffinityKey | value | (agentId: string, sessionId: string) => string | Generate a deterministic aff_\u003cULID\u003e affinity key from an (agentId, sessionId) pair. The same pair always produces the same key, which is stable across restarts. Different pairs produce different keys with overwhelming probability. |
generateWithRuntime | value | (provider: ModelProvider, request: ModelRequest, options?: ModelRuntimeOptions) => Promise<ModelResponse> | Runtime API for generate with runtime; the generated signature shows its accepted inputs and return type. |
getAgentDefinition | value | (value: unknown) => AgentDefinition<unknown, unknown> | undefined | Returns agent definition. |
getCreatedAgent | value | (value: unknown) => CreatedAgent | undefined | Return the CreatedAgent carried by a value, or undefined. |
getLogger | value | () => Logger | Get the currently configured logger. |
getVirtualSandbox | value | (source: FilesystemSource, options?: { mountAt?: string; }) => SandboxFactory | One-liner helper for the most common pattern: mount a single read-only source into a virtual sandbox. Equivalent to: See the package declarations for an example. Used for support agents, runbook lookup, FAQ assistants — anywhere a small Markdown corpus needs to be searchable via the agent's built-in grep/glob/read tools. See the package declarations for an example. |
GlobInput | type | GlobInput | Type contract for glob input. |
globTool | value | (sandbox?: SandboxEnv) => ToolDef<GlobInput, string[]> | Model-callable tool or tool factory for glob. |
GrepInput | type | GrepInput | Type contract for grep input. |
GrepMatch | type | GrepMatch | Type contract for grep match. |
grepTool | value | (sandbox?: SandboxEnv) => ToolDef<GrepInput, GrepMatch[]> | Model-callable tool or tool factory for grep. |
hasSubmissionSettledEntry | value | (path: readonly SessionEntry[], submissionId: string) => boolean | True when the path carries a canonical submission_settled entry for the id. |
hexToBytes | value | (hex: string) => Uint8Array | Runtime API for hex to bytes; the generated signature shows its accepted inputs and return type. |
hmacSha256 | value | (secret: string | Uint8Array, message: Uint8Array) => Promise<Uint8Array> | Runtime API for hmac sha256; the generated signature shows its accepted inputs and return type. |
HookToolContext | type | HookToolContext<TInput, THarness, TDurable> | Type contract for hook tool context. |
HookToolDefinition | type | HookToolDefinition<TInput, TOutput, THarness, TDurable> | Hook-oriented tool declaration supported by defineTool() and useTool(). |
httpFilesystemSource | value | (resources: HttpResource[] | (() => Promise<HttpResource[]>), options?: { name?: string; fetchImpl?: typeof fetch; }) => FilesystemSource | Fetch a list of URLs and mount each response body as a file. Useful for pulling a small published docs set into the sandbox so the built-in read/grep/glob tools can search it like local files. |
HttpResource | type | HttpResource | Type contract for http resource. |
init | value | (options?: AgentInit) => Promise<FabricAgent> | Initialize a runtime-neutral Fabric agent from explicit model, sandbox, policy, store, identity, and lifecycle options. Call agent.session() on the returned value to create or resume a session. Supplying both store and persistence is invalid; a persistence adapter is connected before the agent is returned and connection failures propagate to the caller. |
initializePersistentAgent | value | <TEnv>(created: CreatedAgent<TEnv>, context: PersistentAgentContext<TEnv>, overrides?: AgentInit) => Promise<{ config: PersistentAgentConfig; agent: FabricAgent; }> | Resolve a persistent agent's config for an instance and build a FabricAgent. Runtime-specific resources (session store, workspace roles/skills, loop runtime) are layered by the host that calls this. |
inMemoryApprovalNotificationStore | value | () => ApprovalNotificationDeliveryStore | Process-local atomic delivery state for development and single-process hosts. |
InMemoryAttachmentStore | value | typeof InMemoryAttachmentStore | In-memory attachment store (dev / runtime: 'stateless' / tests). |
InMemoryConversationStreamStore | value | typeof InMemoryConversationStreamStore | In-memory conversation stream store (dev / runtime: 'stateless' / tests). |
inMemoryCostBudgetStore | value | () => CostBudgetStore | Process-local cost budget store. Default when store is not provided. |
InMemoryDispatchQueue | value | typeof InMemoryDispatchQueue | In-process dispatch queue: microtask-drained, concurrent across sessions, serialized within a single session. Suitable for the inline/stateless runtimes and dev. Durable delivery (surviving restarts) is provided by the Temporal-backed queue, which implements this same interface. |
inMemorySessionMemory | value | () => SessionMemory | Process-local in-memory implementation. Default when init({ memory }) is not configured — pair with Postgres for durability across restarts. |
InMemorySessionStore | value | typeof InMemorySessionStore | Storage contract for in memory session. |
inMemorySource | value | (files: Record<string, string | Uint8Array>, options?: { name?: string; }) => FilesystemSource | Build a source from an in-memory map of path -> content. Useful for tests, fixtures, and small static knowledge bases bundled into the agent module itself. |
InMemorySubmissionStore | value | typeof InMemorySubmissionStore | Storage contract for in memory submission. |
InterruptedToolCallRef | type | InterruptedToolCallRef | A tool call settled with an explicit interrupted-outcome marker at terminalization. |
InvalidDeliveredMessageError | value | typeof InvalidDeliveredMessageError | Thrown by parseDeliveredMessage on malformed input. |
invoke | value | { <TInput = JsonObject, TOutput = unknown>(job: DefinedAgent<TInput, TOutput>, options: JobInvocationOptions<TInput>): Promise<JobInvocationReceipt>; <TInput = JsonObject>(request: NamedJobInvocation<TInput>): Promise<JobInvocationRe... | Runtime API for invoke; the generated signature shows its accepted inputs and return type. |
isActionDefinition | value | (value: unknown) => value is ActionDefinition | Checks whether a value is action definition. |
isContextOverflowError | value | (error: unknown) => boolean | Checks whether a value is context overflow error. |
isCreatedAgent | value | (value: unknown) => value is CreatedAgent | Whether a value is a CreatedAgent. |
isDeliveredMessageShape | value | (value: unknown) => boolean | True when a raw value already looks like a DeliveredMessage (has a valid kind). |
isDynamicAgentRendering | value | () => boolean | Checks whether a value is dynamic agent rendering. |
isEvent | value | <T extends AgentEventType>(event: AgentEvent, type: T) => event is Extract<AgentEvent, { type: T; }> | Type guard: narrow an AgentEvent to a specific variant. See the package declarations for an example. |
isFabricError | value | (error: unknown) => error is FabricError | Checks whether a value is fabric error. |
isInMemoryStore | value | (store: SessionStore | undefined) => boolean | Returns true when store is the in-memory default (no appendEntry persistence beyond memory). Used by stateless mode to skip writes. |
isStatelessRuntime | value | (runtime: FabricRuntime | undefined) => boolean | Checks whether a value is stateless runtime. |
isSubmissionPayload | value | (input: unknown, ctx: SubmissionPayloadContext) => input is AgentSubmissionInput | Validate that a parsed JSON payload matches the expected submission shape. Used after deserializing a persisted payload to verify the object is a well-formed AgentSubmissionInput that is consistent with the stored submission metadata. Both dispatch and direct payloads carry the same message: DeliveredMessage field — validated identically here regardless of transport kind. |
isValidAffinityKey | value | (key: string) => boolean | Checks whether a value is valid affinity key. |
JobInvocationContext | type | JobInvocationContext | Type contract for job invocation context. |
JobInvocationOptions | type | JobInvocationOptions<TInput> | Configuration options for job invocation. |
JobInvocationReceipt | type | JobInvocationReceipt | Type contract for job invocation receipt. |
JobInvocationRuntime | type | JobInvocationRuntime | Type contract for job invocation runtime. |
JournalCallbacks | type | JournalCallbacks | Type contract for journal callbacks. |
jsonDeepEqual | value | (a: unknown, b: unknown) => boolean | Structural equality over JSON values (objects compared key-order-insensitively). |
JsonObject | type | JsonObject | Type contract for json object. |
JsonPrimitive | type | JsonPrimitive | Type contract for json primitive. |
JsonSchemaObject | type | JsonSchemaObject | Type contract for json schema object. |
JsonValue | type | JsonValue | Type contract for json value. |
LangfuseClientLike | type | LangfuseClientLike | Optional Langfuse exporter. Adapts Fabric's TelemetrySpan shape to Langfuse's tracing API. The Langfuse client is provided by the caller — we don't take a hard dependency. Install peer dep: See the package declarations for an example. Usage: See the package declarations for an example. |
langfuseExporter | value | (options: LangfuseExporterOptions) => TelemetryExporter | Runtime API for langfuse exporter; the generated signature shows its accepted inputs and return type. |
LangfuseExporterOptions | type | LangfuseExporterOptions | Configuration options for langfuse exporter. |
LEASE_DURATION_MS | value | 30000 | Default lease duration for submission ownership in milliseconds (30 seconds). |
listModelPrices | value | () => ModelPriceRow[] | All currently-registered rows (newest-last). Returns a copy. |
listSandboxBackendFactories | value | () => SandboxBackend[] | Return provider backend names currently available to createSandboxEnv(). |
listSandboxRefDecoders | value | () => string[] | Returns the list of currently registered providers. |
localDirectorySource | value | (hostPath: string, options?: { name?: string; include?: (relativePath: string) => boolean; }) => FilesystemSource | Read a host directory recursively as a read-only source. include is called for each candidate file path (relative to hostPath). Return false to skip. Defaults to including everything. |
LocalSandboxEnv | value | typeof LocalSandboxEnv | Runtime API for local sandbox env; the generated signature shows its accepted inputs and return type. |
LocalSandboxOptions | type | LocalSandboxOptions | Configuration options for local sandbox. |
Logger | type | Logger | Minimal logger seam used by the SDK for non-event diagnostic output (warnings, deprecation notices, telemetry fallbacks). All console.* inside the SDK should route through getLogger() so ops teams can redirect or silence messages in production. The default logger writes to console and respects FABRIC_HARNESS_LOG_LEVEL=debug|info|warn|error|silent (default warn). |
LogLevel | type | LogLevel | Type contract for log level. |
lookupModelPrice | value | (modelRef: string) => ModelPriceRow | undefined | Look up the most recently-registered row matching modelRef. modelRef can be: - 'provider/model' (preferred, e.g. 'openai/gpt-4o') - 'model' alone (e.g. 'gpt-4o') — first row whose model matches wins Provider matching is case-insensitive. Model matching is exact. |
materializeMessageAttachments | value | (message: DeliveredMessage, store: AttachmentStore, options: { scope: string; idPrefix: string; maxCount?: number; maxAttachmentBytes?: number; maxTotalBytes?: number; }) => Promise<DeliveredMessage> | Materialize a message's inline attachments into durable refs: decode the base64 data, store the bytes under scope, and return a NEW message whose attachments carry { type, mimeType, filename?, ref } and no data. Deterministic by construction — attachment ids are ${idPrefix}_${index} and digests derive from content — so an exact redelivery of the same message produces an identical materialized payload (admission idempotency). Messages without inline attachments are returned unchanged (same reference). |
MAX_ATTACHMENT_DATA_LENGTH | value | number | Maximum accepted base64 length for a single inline attachment. |
McpAuthorizationCodeOptions | type | McpAuthorizationCodeOptions | Configuration options for mcp authorization code. |
McpAuthorizationCodeState | type | McpAuthorizationCodeState | Type contract for mcp authorization code state. |
McpClientCredentialsOptions | type | McpClientCredentialsOptions | Configuration options for mcp client credentials. |
McpClientLike | type | McpClientLike | Type contract for mcp client like. |
McpConnectionDefinition | type | McpConnectionDefinition | Type contract for mcp connection definition. |
McpServerConnection | type | McpServerConnection | Type contract for mcp server connection. |
McpServerOptions | type | McpServerOptions | Configuration options for mcp server. |
McpToolDescriptor | type | McpToolDescriptor | Type contract for mcp tool descriptor. |
McpTransport | type | McpTransport | Type contract for mcp transport. |
mergeCapabilityPolicies | value | (definition: CapabilityPolicy | undefined, invocation: CapabilityPolicy | undefined) => CapabilityPolicy | undefined | Treat a definition policy as a security floor. Invocation policy can add denials and approval requirements, but cannot replace definition allowlists. |
mergeSessionEntryBatch | value | (existing: SessionData, entries: readonly SessionEntry[], expectedLeafId?: string, enforceExpectedLeaf?: boolean) => SessionData | false | Merge one idempotent, leaf-fenced entry batch into a session snapshot. Exported for first-party storage adapters so every backend applies the same conflict and exact-replay semantics before its single atomic write. |
messageHasDataAttachments | value | (message: DeliveredMessage) => boolean | True when the message carries at least one inline (base64) attachment. |
mintlifySource | value | (contentRoot: string, options?: { name?: string; include?: (relativePath: string) => boolean; }) => FilesystemSource | Mount a checked-out Mintlify content directory. For a hosted Mintlify MCP server, use connectMcpServer('mintlify', { url, transport: 'streamable-http' }) instead. |
MissingInputStrategy | type | MissingInputStrategy | Type contract for missing input strategy. |
MkdirInput | type | MkdirInput | Type contract for mkdir input. |
mkdirTool | value | (sandbox?: SandboxEnv) => ToolDef<MkdirInput, void> | Model-callable tool or tool factory for mkdir. |
MockModelProvider | value | typeof MockModelProvider | Provider implementation for mock model. |
ModelAttemptEvent | type | ModelAttemptEvent | Type contract for model attempt event. |
ModelConfig | type | ModelConfig | Type contract for model config. |
ModelMessage | type | ModelMessage | Type contract for model message. |
ModelMessageRole | type | ModelMessageRole | Type contract for model message role. |
ModelMetadata | type | ModelMetadata | Type contract for model metadata. |
ModelPriceRow | type | ModelPriceRow | Static USD price table for model providers. Used to populate ModelUsage.costUsd on responses that don't include billing info from the provider directly (most providers — only pi-loop-runtime and a handful of gateways report cost). Prices are stamped with effectiveAt. The table is best-effort: real billing reconciliation should use vendor invoices. Override or extend at runtime with registerModelPrices for custom-rate contracts. |
ModelPricingUsage | type | ModelPricingUsage | Type contract for model pricing usage. |
ModelProvider | type | ModelProvider | Provider implementation for model. |
ModelProviderFactory | type | ModelProviderFactory | Resolves a parsed provider/model-id ref into a concrete provider. Registered factories let out-of-core packages (e.g. |
ModelProviderResolver | type | ModelProviderResolver | Type contract for model provider resolver. |
ModelRequest | type | ModelRequest | Input contract for model. |
ModelResponse | type | ModelResponse | Response contract for model. |
ModelRuntimeOptions | type | ModelRuntimeOptions | Configuration options for model runtime. |
ModelStreamChunk | type | ModelStreamChunk | Type contract for model stream chunk. |
ModelToolCall | type | ModelToolCall | Type contract for model tool call. |
ModelToolSchema | type | ModelToolSchema | Type contract for model tool schema. |
ModelUsage | type | ModelUsage | Type contract for model usage. |
MountedSource | type | MountedSource | Data or filesystem source for mounted. |
MountResult | type | MountResult | Result returned by mount. |
NamedAgentDispatchRequest | type | NamedAgentDispatchRequest | A dispatch request that names its target agent. |
NamedJobInvocation | type | NamedJobInvocation<TInput> | Type contract for named job invocation. |
NativeLoopRuntime | value | typeof NativeLoopRuntime | Runtime API for native loop runtime; the generated signature shows its accepted inputs and return type. |
NetworkEnforcementLayer | type | NetworkEnforcementLayer | Type contract for network enforcement layer. |
NetworkEnforcementRequirement | type | NetworkEnforcementRequirement | Type contract for network enforcement requirement. |
NetworkPolicy | type | NetworkPolicy | Type contract for network policy. |
noopSessionStore | value | NoopSessionStore | Storage contract for noop session. |
NoopSessionStore | value | typeof NoopSessionStore | No-op session store for runtime: 'stateless' mode. All writes are discarded; reads always return the empty initial session. Use this when the agent is intended as a pure request/response handler with no persistence (typical for high-volume webhooks and edge runtimes). Approvals and artifact retrieval are not supported — wiring those up requires a real store. Callers in stateless mode should not rely on artifact persistence or approval gating. |
normalizeDeliveredMessage | value | (input: unknown) => DeliveredMessage | Normalize legacy inputs into a DeliveredMessage: - a string → a user message with that body - a value with a kind discriminator → validated as a DeliveredMessage - any other JSON value → a user message with the JSON-stringified body (matching the historical dispatch rendering, so behavior is unchanged for pre-DeliveredMessage callers) |
ObservabilityCorrelation | type | ObservabilityCorrelation | Type contract for observability correlation. |
ObservabilityObserverOptions | type | ObservabilityObserverOptions | Configuration options for observability observer. |
openAIChatCompletionToModelResponse | value | (json: OpenAIChatCompletion) => ModelResponse | Response contract for open aichat completion to model. |
OpenAICompatibleModelProvider | value | typeof OpenAICompatibleModelProvider | Provider implementation for open aicompatible model. |
OpenAICompatibleProviderOptions | type | OpenAICompatibleProviderOptions | Configuration options for open aicompatible provider. |
OpenAIRealtimeVoiceProvider | value | typeof OpenAIRealtimeVoiceProvider | OpenAI Realtime voice provider. Connects via WebSocket; emits audio_delta / text_delta / transcript / tool_call / response_done events. No transitive dependency on ws — uses the global WebSocket available on Node 22+ and browsers. See the package declarations for an example. |
OpenAIRealtimeVoiceProviderOptions | type | OpenAIRealtimeVoiceProviderOptions | Configuration options for open airealtime voice provider. |
openTelemetryExporter | value | (options: OpenTelemetryExporterOptions) => TelemetryExporter | Bridge Fabric's SDK-neutral TelemetrySpan into a real |
OpenTelemetryExporterOptions | type | OpenTelemetryExporterOptions | Configuration options for open telemetry exporter. |
OperationalMetricsCollector | type | OperationalMetricsCollector | Type contract for operational metrics collector. |
OperationalMetricsSnapshot | type | OperationalMetricsSnapshot | Type contract for operational metrics snapshot. |
OperationalSloEvaluation | type | OperationalSloEvaluation | Type contract for operational slo evaluation. |
OperationalSloTargets | type | OperationalSloTargets | Type contract for operational slo targets. |
parseConversationKey | value | (key: string) => ParsedConversationKey | Parses conversation key. |
ParsedConversationKey | type | ParsedConversationKey | Type contract for parsed conversation key. |
parseDeliveredMessage | value | (value: unknown) => DeliveredMessage | Validate a raw value as a DeliveredMessage. Shared by dispatch admission and the direct HTTP route so every transport produces the same structured error on bad input. |
ParsedModelRef | type | ParsedModelRef | Type contract for parsed model ref. |
parseModelRef | value | (model: string) => ParsedModelRef | undefined | Parses model ref. |
parsePersistentSessionId | value | (storeSessionId: string) => PersistentSessionIdentity | undefined | Inverse of persistentStoreSessionId: decode a store session id back into { agent, instanceId, session }, or undefined if it is not a persistent-instance key. Useful for admin surfaces that list raw session ids. |
parseRetryAfterMs | value | (headerValue: string | null | undefined) => number | undefined | Parse a Retry-After header value (RFC 7231) into milliseconds. Accepts both delta-seconds and HTTP-date forms. Returns undefined when the value is missing or unparseable. |
parseStreamOffset | value | (offset: string | undefined) => number | Parses stream offset. |
PersistenceBundle | type | PersistenceBundle | Complete persistence surface consumed by a Fabric host. |
PersistenceDeleteResult | type | PersistenceDeleteResult | Result returned by persistence delete. |
PersistenceHealth | type | PersistenceHealth | Type contract for persistence health. |
PersistentAgentConfig | type | PersistentAgentConfig | Runtime configuration returned by a createAgent initializer. Mirrors the agent-level slice of AgentInit; instructions becomes the session system prompt (a role), and subagents map to named roles. |
PersistentAgentContext | type | PersistentAgentContext<TEnv> | Per-interaction context passed to a createAgent initializer. id is the URL <id> of the addressed instance (or the dispatch target id); env is the platform environment supplied by the runtime. |
PersistentAgentDurabilityConfig | type | PersistentAgentDurabilityConfig | Static retry and wall-clock budget applied to every durable submission. |
persistentAgentSubmissionDurability | value | (created: CreatedAgent, acceptedAt: number) => import("./submission-store.js").AgentSubmissionDurability | undefined | Resolve a static policy into the store's absolute durability stamp. |
PersistentAgentTriggers | type | PersistentAgentTriggers | Public triggers supported by persistent agents. Scheduling requires a concrete instance id and message, so cron belongs on a finite dispatcher job. |
persistentConfigToAgentInit | value | (config: PersistentAgentConfig, id: string) => AgentInit | Translate a PersistentAgentConfig into an AgentInit. |
PersistentInstanceIdentity | type | PersistentInstanceIdentity | Type contract for persistent instance identity. |
persistentInstanceStoreId | value | (agentName: string, instanceId: string) => string | Instance-scoped metadata key shared by every named session of one persistent agent. |
PersistentSessionIdentity | type | PersistentSessionIdentity | Decoded identity of a persistent instance session store key. |
persistentStoreSessionId | value | (agentName: string, instanceId: string, sessionName?: string) => string | Store-session key for a persistent instance's named session. Collapses the (agentName, instanceId, sessionName) identity onto Fabric's single-string sessionId, keeping persistent sessions inside the existing session stores. |
PiAgentLoopRuntime | value | typeof PiAgentLoopRuntime | Runtime API for pi agent loop runtime; the generated signature shows its accepted inputs and return type. |
PiAgentLoopRuntimeOptions | type | PiAgentLoopRuntimeOptions | Configuration options for pi agent loop runtime. |
PiCustomModel | type | PiCustomModel | Type contract for pi custom model. |
PipelineVoiceProvider | value | typeof PipelineVoiceProvider | Provider implementation for pipeline voice. |
PipelineVoiceProviderOptions | type | PipelineVoiceProviderOptions | Configuration options for pipeline voice provider. |
policiedFetch | value | (fetchImpl: typeof fetch, policy?: CapabilityPolicy, options?: PoliciedFetchOptions) => typeof fetch | Wrap a Fetch implementation with URL, protocol, host, redirect, and optional DNS-answer checks from a capability policy. This wrapper governs only calls made through the returned function; it does not intercept global Fetch, Axios, raw sockets, subprocesses, or third-party clients. Pair it with a container, cluster, or provider egress boundary for untrusted production workloads. |
PoliciedFetchOptions | type | PoliciedFetchOptions | Wrap a fetch-like function with CapabilityPolicy enforcement. Tools and connectors that make outbound HTTP should accept a custom fetch and pass the result of policiedFetch(fetch, policy). Throws a FabricError (POLICY_DENIED) when a request violates the policy; never sends a forbidden request. |
policiedSandboxEnv | value | (inner: SandboxEnv, policy: CapabilityPolicy | undefined) => SandboxEnv | Wrap a SandboxEnv with CapabilityPolicy enforcement at the sandbox layer. Without this decorator, agent code that calls (await session.sandbox).exec(...) directly bypasses the policy that session.shell() and tool dispatch enforce. policiedSandboxEnv() closes that gap by re-running the same policy evaluation against exec / readFile / writeFile / mkdir / rm / etc. Throws FabricError: - COMMAND_DENIED when an exec is denied or requires approval. - POLICY_DENIED when a filesystem op is denied or requires approval. The decorator does NOT auto-resolve requireApproval p... |
PolicyDecision | type | PolicyDecision | Type contract for policy decision. |
projectConversationRecords | value | (records: readonly ConversationStreamRecord[]) => ConversationSnapshot | Project canonical session records into a stable, UI-oriented protocol. |
PromptOptions | type | PromptOptions<TResult> | Configuration options for prompt. |
PromptRunInput | type | PromptRunInput | Type contract for prompt run input. |
PromptRunResult | type | PromptRunResult | Result returned by prompt run. |
ProviderHttpError | value | typeof ProviderHttpError | Error raised for provider http failures. |
ProvidersConfig | type | ProvidersConfig | Type contract for providers config. |
ProviderSettings | type | ProviderSettings | Type contract for provider settings. |
pruneSnapshots | value | (snapshotRoot: string, options?: SnapshotPruneOptions) => Promise<SnapshotPruneResult> | Runtime API for prune snapshots; the generated signature shows its accepted inputs and return type. |
RateLimiter | type | RateLimiter | Type contract for rate limiter. |
RateLimiterAcquireOptions | type | RateLimiterAcquireOptions | Process-local rate limiter for outbound provider calls. Use to prevent a fleet of agents from stampeding a single API key when the host runs many sessions in parallel. The default token-bucket implementation is in-memory; @fabric-harness/node exports redisRateLimiter for shared limits across processes. fabric-harness ships this as a generic primitive — the same limiter can be reused for outbound HTTP calls inside connectors, webhook fan-out, or anywhere else throttling is useful. |
readConversationFromFold | value | (store: ConversationStreamStore, path: string, options?: { offset?: string; limit?: number; }) => Promise<ConversationStreamReadResult> | Read a conversation from its newest validated fold checkpoint plus the log suffix. Non-origin offsets always use the raw store so resume semantics stay unchanged. Invalid checkpoints are disposable and fall back to full replay. |
readConversationReply | value | (snapshot: ConversationSnapshot, submissionId: string) => ConversationReply | Read the canonical assistant reply for a durable submission. Submission ids are used when available. The positional fallback supports conversations written by older Harness servers that predate submission correlation on individual entries. |
ReaddirInput | type | ReaddirInput | Type contract for readdir input. |
readdirTool | value | (sandbox?: SandboxEnv) => ToolDef<ReaddirInput, string[]> | Model-callable tool or tool factory for readdir. |
ReadFileBufferInput | type | ReadFileBufferInput | Type contract for read file buffer input. |
readFileBufferTool | value | (sandbox?: SandboxEnv) => ToolDef<ReadFileBufferInput, Uint8Array> | Model-callable tool or tool factory for read file buffer. |
ReadFileInput | type | ReadFileInput | Type contract for read file input. |
readFileTool | value | (sandbox?: SandboxEnv, packagedSkills?: Record<string, PackagedSkillDirectory>) => ToolDef<ReadFileInput, string> | Model-callable tool or tool factory for read file. |
readJsonBody | value | (request: Request, limitBytes?: number) => Promise<RequestBody | undefined> | Reads the body once and returns the raw bytes, the decoded text, and the parsed JSON together — so a channel can HMAC-verify the exact bytes and use the JSON without re-reading the (already consumed) stream. Returns undefined only when the body exceeds limitBytes. |
readRequestBody | value | (request: Request, limitBytes?: number) => Promise<Uint8Array | undefined> | Reads the full request body as bytes, or returns undefined if it exceeds limitBytes. NOTE: this consumes the request stream (single read). Signature-verifying channels need the exact bytes for HMAC and the parsed JSON afterward — don't call request.json() as well. Use readJsonBody to get both from one read. |
redactError | value | (error: unknown, options?: RedactionOptions) => JsonObject | Error raised for redact failures. |
RedactionOptions | type | RedactionOptions | Configuration options for redaction. |
redactJson | value | <T>(value: T, options?: RedactionOptions) => T | Runtime API for redact json; the generated signature shows its accepted inputs and return type. |
redactText | value | (value: string, options?: RedactionOptions) => string | Runtime API for redact text; the generated signature shows its accepted inputs and return type. |
registerCreatedAgentName | value | (agent: CreatedAgent, name: string) => void | Register a name for a CreatedAgent so dispatch(agent, ...) can resolve it. |
registeredModelProviders | value | () => string[] | Names of externally registered providers, for diagnostics. |
registerJobName | value | <TInput, TOutput>(job: DefinedAgent<TInput, TOutput>, name: string) => void | Registers job name. |
registerModelPrices | value | (rows: ModelPriceRow[]) => void | Add or override price rows. Later rows take precedence over earlier ones. |
registerModelProvider | value | (name: string, factory: ModelProviderFactory) => void | Register a model provider resolvable via FABRIC_MODEL=<name>/<model-id>. Built-in providers always take precedence; registering a name a built-in already owns has no effect on routing. Idempotent by name (last registration wins). Call at module import time. |
registerSandbox | value | (env: SandboxEnv, options?: { ownerSessionId?: string; }) => SandboxRef | Register a sandbox in the in-process registry and return a portable ref. Subsequent calls for the same env return the same ref. |
registerSandboxBackendFactory | value | (backend: SandboxBackend, factory: SandboxFactory) => void | Register an implementation for a non-core SandboxBackend name. Provider packages use this hook so the shared runtime can resolve backends such as databricks without depending on them. |
registerSandboxRefDecoder | value | (provider: string, decoder: SandboxRefDecoder) => void | Register a decoder for provider so attachSandbox(serialized) can rehydrate a sandbox from another process. Typically called once at startup by the package that owns the provider integration (e.g. @fabric-harness/connectors/e2b registers the e2b provider). |
RemoteSandboxApi | type | RemoteSandboxApi | Type contract for remote sandbox api. |
RemoteSandboxOptions | type | RemoteSandboxOptions | Configuration options for remote sandbox. |
renderDeliveredMessage | value | (message: DeliveredMessage) => string | Render a delivered message to the prompt text form. User messages pass their body through verbatim; signals render as their XML envelope via the shared renderSignalMessage machinery. |
RequestBody | type | RequestBody | Type contract for request body. |
resetDispatchRuntime | value | () => void | Clear the ambient dispatch runtime (tests/teardown). |
resetJobInvocationRuntime | value | () => void | Runtime API for reset job invocation runtime; the generated signature shows its accepted inputs and return type. |
resetModelPricesToBuiltins | value | () => void | Reset the registry to the built-in seed (test/utility). |
ResolvedDynamicModelProvider | type | ResolvedDynamicModelProvider | Provider and normalized model selected for a dynamically rendered model reference. |
ResolvedModelProvider | type | ResolvedModelProvider | Provider implementation for resolved model. |
resolveModelProvider | value | (options?: ResolveModelProviderOptions) => ResolvedModelProvider | Resolves model provider. |
ResolveModelProviderOptions | type | ResolveModelProviderOptions | Configuration options for resolve model provider. |
resolveRuntimeMode | value | (options: Pick<AgentInit, "runtime" | "store" | "persistence">, env?: Record<string, string | undefined>) => RuntimeModeResolution | Resolve the effective runtime mode for an init() call, applying production safety rules: - In production (FABRIC_ENV=production or NODE_ENV=production), choosing stateless is allowed but logged as an explicit choice. - inline (the default) without an explicit SessionStore falls back to in-memory storage. In production this emits a warning unless FABRIC_ALLOW_EPHEMERAL_STATE=1 is set or runtime is explicitly 'stateless'. - Unknown runtime values fall through to 'inline' with a warning. |
RESULT_END_DELIMITER | value | "---RESULT_END---" | Constant defining result end delimiter. |
RESULT_START_DELIMITER | value | "---RESULT_START---" | Constant defining result start delimiter. |
ResultExtractionOptions | type | ResultExtractionOptions | Configuration options for result extraction. |
ResultOutcome | type | ResultOutcome<TResult> | Type contract for result outcome. |
ResultToolBundle | type | ResultToolBundle<TResult> | Type contract for result tool bundle. |
ResultUnavailableError | value | typeof ResultUnavailableError | Thrown when the LLM calls the give_up tool, indicating it cannot produce a result that conforms to the required schema. |
ResultValidator | type | ResultValidator<TResult> | Type contract for result validator. |
RetrievedChunk | type | RetrievedChunk | Generic, provider-agnostic retrieval seam. RAG is query-time, so it does NOT fit FilesystemSource (an eager full-dump mount) — a retriever resolves the top matches for a query on demand. Databricks AI Search is the flagship implementation, but this is reusable for any vector store. |
RetrieveOptions | type | RetrieveOptions | Configuration options for retrieve. |
Retriever | type | Retriever | Type contract for retriever. |
RmInput | type | RmInput | Type contract for rm input. |
rmTool | value | (sandbox?: SandboxEnv) => ToolDef<RmInput, void> | Model-callable tool or tool factory for rm. |
Role | type | Role | Type contract for role. |
runAction | value | <TInput, TOutput>(action: ActionDefinition<TInput, TOutput>, host: ActionHost, input?: unknown) => Promise<TOutput> | Validate input, run the action against host, validate + JSON-clone the output. The returned value is always safely serializable (a fresh JSON clone), so callers can persist or transmit it without sharing references. |
RuntimeModeResolution | type | RuntimeModeResolution | Type contract for runtime mode resolution. |
runWithJobInvocation | value | <T>(context: JobInvocationContext, fn: () => Promise<T> | T) => Promise<T> | T | Runs with job invocation. |
runWithSubmissionContext | value | <T>(context: SubmissionContext, fn: () => Promise<T> | T) => Promise<T> | T | Run fn with context as the ambient submission correlation. |
sameApprovalOperation | value | (grant: ApprovalGrant, input: { toolCallId: string; toolInput: unknown; principal: FabricPrincipal; }) => boolean | Runtime API for same approval operation; the generated signature shows its accepted inputs and return type. |
SandboxAdapterDescriptor | type | SandboxAdapterDescriptor | Adapter expectations: - Every backend must expose the SandboxEnv contract above and map paths into a scoped workspace. - Secrets and provider credentials must stay in adapter-owned environment/config, not model context. - exec should enforce backend-specific command, network, and timeout policy before process launch. - snapshot/restore is optional because not all targets support filesystem or VM snapshots. - Future adapters should be added without changing session/runtime code. Planned backends: local, Docker, Azure Container Apps, Azure Container Instances, AKS, Databricks, E2B, Daytona, C... |
SandboxBackend | type | SandboxBackend | Type contract for sandbox backend. |
SandboxCapabilities | type | SandboxCapabilities | Type contract for sandbox capabilities. |
SandboxEnv | type | SandboxEnv | Type contract for sandbox env. |
SandboxExecOptions | type | SandboxExecOptions | Configuration options for sandbox exec. |
SandboxFactory | type | SandboxFactory | Factory for sandbox. |
SandboxFactoryOptions | type | SandboxFactoryOptions | Configuration options for sandbox factory. |
SandboxFork | type | SandboxFork | Type contract for sandbox fork. |
SandboxOrphanSettlement | type | SandboxOrphanSettlement | Type contract for sandbox orphan settlement. |
SandboxRef | type | SandboxRef | Type contract for sandbox ref. |
SandboxRefDecoder | type | SandboxRefDecoder | Decoder for a SerializedSandboxRef.provider. Returns a SandboxFactory that, when invoked, produces a SandboxEnv connected to the existing remote sandbox identified by providerData. Decoders SHOULD attach without owning the remote sandbox's lifecycle — the returned env's cleanup() should detach, not destroy. |
SandboxSnapshot | type | SandboxSnapshot | Type contract for sandbox snapshot. |
sanitizeObservabilityData | value | (data: JsonObject, additionalSecrets?: string[]) => JsonObject | Runtime API for sanitize observability data; the generated signature shows its accepted inputs and return type. |
sanitizePublicJson | value | <T>(value: T) => T | Runtime API for sanitize public json; the generated signature shows its accepted inputs and return type. |
sanitizePublicText | value | (value: string) => string | Remove credentials and host filesystem locations from caller-visible text. |
schema | value | { string(): Schema<string>; number(): Schema<number>; boolean(): Schema<boolean>; unknown(): Schema<unknown>; enum<const T extends readonly [string, ...string[]]>(values: T): Schema<T[number]>; array<T>(item: Schema<T>): Sch... | Runtime API for schema; the generated signature shows its accepted inputs and return type. |
Schema | type | Schema<T> | Type contract for schema. |
SchemaIssue | type | SchemaIssue | Type contract for schema issue. |
SchemaValidationError | value | typeof SchemaValidationError | Error raised for schema validation failures. |
SearchToolInput | type | SearchToolInput | Type contract for search tool input. |
SearchToolOptions | type | SearchToolOptions | Configuration options for search tool. |
SearchToolResult | type | SearchToolResult | Result returned by search tool. |
secret | value | (name: string) => SecretRef | Runtime API for secret; the generated signature shows its accepted inputs and return type. |
SecretProvider | type | SecretProvider | Provider implementation for secret. |
SecretRef | type | SecretRef | Type contract for secret ref. |
SecretResolutionContext | type | SecretResolutionContext | Type contract for secret resolution context. |
secretResolver | value | (provider: SecretProvider, context?: SecretResolutionContext) => (ref: SecretRef) => Promise<string | undefined> | Adapt a provider to the existing init({ resolveSecret }) callback. |
SerializedFabricError | type | SerializedFabricError | Error raised for serialized fabric failures. |
SerializedSandboxRef | type | SerializedSandboxRef | Cross-process / cross-machine sandbox reference. Created by session.sandboxRef({ portable: true }) and re-attached via attachSandbox(serialized) in a separate process. Each provider string maps to a decoder registered via registerSandboxRefDecoder(). |
serializeFabricError | value | (error: unknown, audience?: "public" | "developer", fallback?: Omit<FabricErrorOptions, "cause">) => SerializedFabricError | Convert any thrown value into the stable public/developer transport shape. |
serializeSandboxRef | value | (ref: SandboxRef, ownerSessionId?: string, tenantId?: string) => SerializedSandboxRef | Serialize an in-process SandboxRef into the cross-process form. Requires the underlying sandbox to implement encodeRef(). Throws SANDBOX_UNAVAILABLE if the backend is in-process-only. |
SessionData | type | SessionData | Type contract for session data. |
SessionEntry | type | SessionEntry<TData> | Type contract for session entry. |
SessionEntryType | type | SessionEntryType | Type contract for session entry type. |
SessionHistory | value | typeof SessionHistory | Runtime API for session history; the generated signature shows its accepted inputs and return type. |
SessionMemory | type | SessionMemory | Type contract for session memory. |
SessionMemoryEntry | type | SessionMemoryEntry<TValue> | Persistent key/value store for facts an agent should remember across sessions — borrower preferences, prior outcomes, learned task history. Distinct from SessionEntry (which is the audit log): memory is for recall, entries are for audit. Memory writes do NOT land in the session log, so they don't pollute prompt context unless the agent explicitly reads them. Tenancy: every operation accepts an optional tenantId. Two tenants with the same key get isolated values. tenantId defaults to the empty string for non-tenant deployments. |
SessionMemoryFilter | type | SessionMemoryFilter | Type contract for session memory filter. |
SessionMemoryGetOptions | type | SessionMemoryGetOptions | Configuration options for session memory get. |
SessionMemorySetInput | type | SessionMemorySetInput<TValue> | Type contract for session memory set input. |
SessionOptions | type | SessionOptions | Configuration options for session. |
SessionStore | type | SessionStore | Storage contract for session. |
setLogger | value | (logger: Logger) => void | Replace the global SDK logger. Call once at startup before any init(). Pass a custom Logger to redirect to your structured logging system. |
ShellOptions | type | ShellOptions | Configuration options for shell. |
shellQuote | value | (value: string) => string | Runtime API for shell quote; the generated signature shows its accepted inputs and return type. |
ShellResult | type | ShellResult | Result returned by shell. |
Skill | type | Skill | Type contract for skill. |
SkillOptions | type | SkillOptions<TResult> | Configuration options for skill. |
slackApprovalNotifier | value | (options: { webhookUrl: string; fetch?: typeof fetch; }) => ApprovalNotifier | Slack incoming-webhook notifier. The webhook URL remains in host configuration, never event data. |
SnapshotPruneOptions | type | SnapshotPruneOptions | Configuration options for snapshot prune. |
SnapshotPruneResult | type | SnapshotPruneResult | Result returned by snapshot prune. |
StateSetter | type | StateSetter<T> | Type contract for state setter. |
StatInput | type | StatInput | Type contract for stat input. |
statTool | value | (sandbox?: SandboxEnv) => ToolDef<StatInput, FileStat> | Model-callable tool or tool factory for stat. |
StdioMcpClient | value | typeof StdioMcpClient | Client implementation for stdio mcp. |
StdioMcpClientOptions | type | StdioMcpClientOptions | Configuration options for stdio mcp client. |
StoredAttachment | type | StoredAttachment | Type contract for stored attachment. |
StreamListenerRegistry | value | typeof StreamListenerRegistry | Process-local listener registry shared by store implementations — registration, unsubscribe-and-prune, and error-swallowing notify. |
SttEvent | type | SttEvent | Type contract for stt event. |
SttProvider | type | SttProvider | Provider implementation for stt. |
SttSession | type | SttSession | Type contract for stt session. |
SttSessionOptions | type | SttSessionOptions | Configuration options for stt session. |
SttSessionUsage | type | SttSessionUsage | Type contract for stt session usage. |
StubFabricAgent | value | typeof StubFabricAgent | Runtime API for stub fabric agent; the generated signature shows its accepted inputs and return type. |
StubFabricSession | value | typeof StubFabricSession | Runtime API for stub fabric session; the generated signature shows its accepted inputs and return type. |
SubagentDefinition | type | SubagentDefinition | Type contract for subagent definition. |
SubmissionAbortedError | value | typeof SubmissionAbortedError | Error raised for submission aborted failures. |
SubmissionAdmissionBackend | type | SubmissionAdmissionBackend<Row> | Storage callbacks for admitSubmissionWithBackend. Every callback runs inside the transaction the caller has already opened (or the backend's equivalent atomicity scope). Callbacks may return plain values (synchronous backends) or native Promises — non-native thenables are not supported. |
SubmissionAdmissionRow | type | SubmissionAdmissionRow | The minimal shape admitSubmissionWithBackend needs from a persisted submission row: the transport kind and persisted payload it compares against the incoming admission. payload may be the serialized JSON string or an already-deserialized object (e.g. a Postgres JSONB column). |
SubmissionAttemptRef | type | SubmissionAttemptRef | Type contract for submission attempt ref. |
SubmissionClaimRef | type | SubmissionClaimRef | Type contract for submission claim ref. |
SubmissionContext | type | SubmissionContext | Type contract for submission context. |
SubmissionDurability | type | SubmissionDurability | Type contract for submission durability. |
SubmissionExecuteOptions | type | SubmissionExecuteOptions | Configuration options for submission execute. |
SubmissionExecutor | type | SubmissionExecutor | How the runner touches sessions. execute applies the submission's input to the addressed instance session and resolves with the turn result; everything else is store-level and must not require a live agent. Contract requirements: - execute must be idempotent by submission id (a resumed attempt whose input entry already exists must not append it again). - recordTerminal settles the conversation to a deterministic rest state (unresolved trailing tool calls get explicit interrupted-outcome markers — NEVER re-executed) and appends a terminal advisory. - appendSettlement appends the cano... |
SubmissionInsertRow | type | SubmissionInsertRow | The queued row that admitSubmissionWithBackend writes on first admission. |
SubmissionInspection | type | SubmissionInspection | Coarse persisted-progress classification consumed by reconciliation. |
SubmissionInterruptedError | value | typeof SubmissionInterruptedError | Error raised for submission interrupted failures. |
SubmissionInterruption | type | SubmissionInterruption | Type contract for submission interruption. |
SubmissionPayloadContext | type | SubmissionPayloadContext | Context needed for submission payload validation. Implementations extract these fields from their storage-specific row/document type before calling isSubmissionPayload. |
SubmissionRetryExhaustedError | value | typeof SubmissionRetryExhaustedError | Error raised for submission retry exhausted failures. |
SubmissionRunner | type | SubmissionRunner | Type contract for submission runner. |
SubmissionRunnerOptions | type | SubmissionRunnerOptions | Configuration options for submission runner. |
submissionSessionKey | value | (input: Pick<AgentSubmissionInput, "agent" | "id" | "session">) => string | Store-session FIFO key of a submission (re-exported convenience). |
SubmissionSettledRecord | type | SubmissionSettledRecord | Minimal canonical settlement record for a direct submission. The conversation-stream phase reuses this shape as the durable terminal record a reconnecting waiter observes. |
SubmissionSettlement | type | SubmissionSettlement | Type contract for submission settlement. |
submissionSettlementEntryId | value | (submissionId: string) => string | Deterministic canonical settlement entry id for a submission. |
SubmissionSettlementObligation | type | SubmissionSettlementObligation | Type contract for submission settlement obligation. |
submissionStoreSessionId | value | (input: Pick<AgentSubmissionInput, "agent" | "id" | "session">) => string | The harness identity string (agent:<name>:<id>:<session>) targeted by a submission input. This is the persistentStoreSessionId of the addressed instance session and the per-session FIFO key of the store. |
SubmissionTelemetryEvent | type | SubmissionTelemetryEvent | Type contract for submission telemetry event. |
SubmissionTelemetrySink | type | SubmissionTelemetrySink | Type contract for submission telemetry sink. |
SubmissionTimeoutError | value | typeof SubmissionTimeoutError | Error raised for submission timeout failures. |
SuspendingSandboxEnv | value | typeof SuspendingSandboxEnv | Decorator that adds idle-based auto-suspend to any SandboxEnv whose underlying implementation supports suspend() / resume(). If the inner env doesn't implement them, the decorator is a no-op pass-through (the idle timer never fires anything). The decorator tracks a lastAccessAt timestamp on every operation. After idleSuspendMs elapses without activity, it calls inner.suspend(). The next operation transparently calls inner.resume() first (unless autoResumeOnAccess: false). cleanup() cancels the idle timer. |
SuspendingSandboxOptions | type | SuspendingSandboxOptions | Configuration options for suspending sandbox. |
TaskOptions | type | TaskOptions<TResult> | Configuration options for task. |
TelemetryExporter | type | TelemetryExporter | Type contract for telemetry exporter. |
TelemetrySpan | type | TelemetrySpan | Type contract for telemetry span. |
tenantCostLimit | value | (tenantId: string, options: TenantCostLimit) => CostLimit | Sugar over CostLimit.perScope + scopeKey + store for the common "per-tenant ceiling per period" pattern. Pick one of perDayUsd, perHourUsd, or perMonthUsd; when multiple are set, the most restrictive (smallest absolute) wins. Scope key convention: tenant:<id>:<period> where <period> is day:YYYY-MM-DD, hour:YYYY-MM-DDTHH:00Z, or month:YYYY-MM. Reset semantics (rollover) are the host's job — call store.reset(scopeKey) from a scheduled task to clear the period total. See the package declarations for an example. |
TenantCostLimit | type | TenantCostLimit | Type contract for tenant cost limit. |
toFabricError | value | (error: unknown, fallback: Omit<FabricErrorOptions, "cause">) => FabricError | Error raised for to fabric failures. |
tokenBucketRateLimiter | value | (options: TokenBucketRateLimiterOptions) => RateLimiter | In-memory token-bucket rate limiter. Each key has its own bucket — keys are independent (waiting on one key doesn't block another). Buckets refill continuously at tokensPerSecond. |
TokenBucketRateLimiterOptions | type | TokenBucketRateLimiterOptions | Configuration options for token bucket rate limiter. |
ToolCall | type | ToolCall<TInput> | Type contract for tool call. |
ToolCallResult | type | ToolCallResult<TOutput> | Result returned by tool call. |
ToolContext | type | ToolContext | Type contract for tool context. |
ToolDef | type | ToolDef<TInput, TOutput> | Type contract for tool def. |
ToolEffect | type | ToolEffect | Type contract for tool effect. |
ToolHarness | type | ToolHarness | Type contract for tool harness. |
ToolPolicy | type | ToolPolicy | Type contract for tool policy. |
ToolProgressLogger | type | ToolProgressLogger | Type contract for tool progress logger. |
ToolStep | type | ToolStep | Type contract for tool step. |
toolsToModelSchemas | value | (tools: Iterable<ToolDef>) => ModelToolSchema[] | Runtime API for tools to model schemas; the generated signature shows its accepted inputs and return type. |
toOpenAIMessage | value | (message: ModelMessage) => Record<string, unknown> | Runtime API for to open aimessage; the generated signature shows its accepted inputs and return type. |
toOpenAITool | value | (tool: ModelToolSchema) => Record<string, unknown> | Model-callable tool or tool factory for to open ai. |
TtsProvider | type | TtsProvider | Provider implementation for tts. |
TtsSynthesisOptions | type | TtsSynthesisOptions | Configuration options for tts synthesis. |
TtsSynthesisUsage | type | TtsSynthesisUsage | Type contract for tts synthesis usage. |
TurnJournalState | type | TurnJournalState | Type contract for turn journal state. |
UnimplementedSandboxEnv | value | typeof UnimplementedSandboxEnv | Runtime API for unimplemented sandbox env; the generated signature shows its accepted inputs and return type. |
unregisterSandbox | value | (refId: string) => void | Mark a registered sandbox as dead so future attach attempts fail. Called from the owner session's cleanup path. |
unregisterSandboxBackendFactory | value | (backend: SandboxBackend) => void | Remove a provider-owned backend factory, primarily for tests and controlled shutdown. |
unregisterSandboxRefDecoder | value | (provider: string) => void | Test/internal: remove a decoder. |
useAgentFinish | value | (run: (context: DynamicAgentFinishContext) => void | Promise<void>) => void | Runtime API for use agent finish; the generated signature shows its accepted inputs and return type. |
useAgentStart | value | (run: (context: DynamicAgentStartContext) => void | Promise<void>) => void | Runtime API for use agent start; the generated signature shows its accepted inputs and return type. |
useDataWriter | value | <T>(name: string, options?: { schema?: Schema<T>; }) => (data: T) => void | Writer implementation for use data. |
useDelivery | value | () => DeliveredMessage | Runtime API for use delivery; the generated signature shows its accepted inputs and return type. |
useDispatchMessage | value | () => (message: DeliveredMessage | string) => Promise<import("./dispatch.js").DispatchReceipt> | Runtime API for use dispatch message; the generated signature shows its accepted inputs and return type. |
useInitialData | value | <T = unknown>() => T | Runtime API for use initial data; the generated signature shows its accepted inputs and return type. |
useInstruction | value | (text: string) => void | Runtime API for use instruction; the generated signature shows its accepted inputs and return type. |
useMcpConnection | value | (definition: McpConnectionDefinition) => void | Runtime API for use mcp connection; the generated signature shows its accepted inputs and return type. |
useModel | value | (model: NonNullable<AgentInit["model"]>, options?: UseModelOptions) => void | Runtime API for use model; the generated signature shows its accepted inputs and return type. |
UseModelOptions | type | UseModelOptions | Configuration options for use model. |
usePersistentState | value | <T>(name: string, defaultValue: T, options?: { schema?: Schema<T>; }) => [T, StateSetter<T>] | Runtime API for use persistent state; the generated signature shows its accepted inputs and return type. |
useResponseFinish | value | (run: DynamicMetadataCallback) => void | Runtime API for use response finish; the generated signature shows its accepted inputs and return type. |
useResponseStart | value | (run: DynamicMetadataCallback) => void | Runtime API for use response start; the generated signature shows its accepted inputs and return type. |
useSandbox | value | (sandbox: SandboxBackend | SandboxFactory | SandboxEnv, options?: UseSandboxOptions) => void | Sandbox adapter for use. |
UseSandboxOptions | type | UseSandboxOptions | Configuration options for use sandbox. |
useSkill | value | (skill: Skill) => void | Runtime API for use skill; the generated signature shows its accepted inputs and return type. |
useSubagent | value | (definition: SubagentDefinition) => void | Runtime API for use subagent; the generated signature shows its accepted inputs and return type. |
useTool | value | <TInput = unknown, TOutput = unknown, THarness extends boolean = false, TDurable extends boolean = false>(tool: ToolDef<TInput, TOutput> | HookToolDefinition<TInput, TOutput, THarness, TDurable>) => void | Model-callable tool or tool factory for use. |
validatePersistentAgentDurability | value | (durability: PersistentAgentDurabilityConfig) => PersistentAgentDurabilityConfig | Validate and normalize a persistent agent's static submission policy. |
validatePersistentInitialData | value | (created: CreatedAgent, initialData: unknown) => JsonValue | Validate and normalize creation data before an instance generation is admitted. |
validatePersistentInstanceContact | value | (uid: string | null | undefined, initialData: unknown) => void | Reject contradictory existing-incarnation and instance-creation inputs. |
validateResult | value | <TResult>(value: unknown, validator?: ResultValidator<TResult>, extraction?: boolean | ResultExtractionOptions) => Promise<TResult> | Result returned by validate. |
VERCEL_AI_GATEWAY_BASE_URL | value | "https://ai-gateway.vercel.sh/v1" | Default base URL for Vercel AI Gateway's OpenAI-compatible Chat Completions endpoint. The gateway accepts the standard OpenAI request body and routes through to the configured provider; switching from OpenAI to the gateway is just a base-URL change. See https://vercel.com/docs/ai-gateway/sdks-and-apis/openai-compat |
vercelAIGateway | value | (options: VercelAIGatewayProviderOptions) => OpenAICompatibleModelProvider | Vercel AI Gateway model provider. The gateway is an OpenAI-compatible HTTP endpoint that brokers between your agent and any of the major model providers (OpenAI, Anthropic, Google, xAI, Groq, etc.) with a single key, observability, caching, and spend controls. Use this provider on any deploy target — Node, Cloudflare Workers, Vercel — to route inference through the gateway. See the package declarations for an example. Returns an OpenAICompatibleModelProvider configured for the gateway — use it anywhere a ModelProvider is accepted. Compatible with fabric-harness's tool-calling, retries,... |
VercelAIGatewayProviderOptions | type | VercelAIGatewayProviderOptions | Configuration options for vercel aigateway provider. |
verifyAttachmentBytes | value | (ref: AttachmentRef, bytes: Uint8Array) => Promise<void> | Verify that bytes match the ref's digest (and declared size), throwing AttachmentStoreError('DIGEST_MISMATCH') otherwise. Every store's put MUST run this check before persisting. |
verifyHmacSha256 | value | (secret: string | Uint8Array, message: Uint8Array, signature: Uint8Array) => Promise<boolean> | Constant-time HMAC-SHA256 verification (via crypto.subtle.verify). |
VertexAIModelProvider | value | typeof VertexAIModelProvider | Provider implementation for vertex aimodel. |
VertexAIProviderOptions | type | VertexAIProviderOptions | Configuration options for vertex aiprovider. |
VirtualSandboxEnv | value | typeof VirtualSandboxEnv | Virtual sandbox backend powered by just-bash. Provides an in-memory filesystem and a bash subset (grep, glob, cat, read, mkdir, rm, ls, echo, etc.) without shelling out to the host. The backend is fast, cheap, safe, and high-concurrency. Selected automatically by the bare @fabric-harness/sdk import when the caller doesn't pass sandbox. Override with 'local', 'docker', a SandboxFactory, or a SandboxEnv when you need real shell access. |
VoiceAudioFormat | type | VoiceAudioFormat | Bidirectional voice / audio streaming surface. fabric-harness ships an OpenAI Realtime implementation; bring-your-own-vendor for Anthropic / Gemini Live / on-prem TTS+ASR pipelines. Audio frames flow in raw bytes — the standard format is PCM 16-bit little-endian at 24kHz mono (OpenAI Realtime default). Telephony bridges (Twilio Media Streams μ-law 8kHz, etc.) resample at the edge. Tool execution is the caller's responsibility: a tool_call event surfaces, the host code runs the tool through whatever governance gates apply (approvals, cost caps, rate limits), then calls `submitToolResult(... |
VoiceConnectOptions | type | VoiceConnectOptions | Configuration options for voice connect. |
VoiceEvent | type | VoiceEvent | Events streamed from a VoiceSession. audio_delta carries raw audio bytes; text_delta and transcript carry text; tool_call and response_done mark structured boundaries; error is fatal. |
VoiceProvider | type | VoiceProvider | Provider implementation for voice. |
VoiceSession | type | VoiceSession | Type contract for voice session. |
VoiceToolResultInput | type | VoiceToolResultInput | Type contract for voice tool result input. |
VoiceWsClientEvent | type | VoiceWsClientEvent | Type contract for voice ws client event. |
VoiceWsClientHandle | type | VoiceWsClientHandle | Type contract for voice ws client handle. |
VoiceWsClientOptions | type | VoiceWsClientOptions | Lightweight WebSocket client for the Node server's WS /sessions/:id/voice endpoint. Server-side bridge owns the provider connection and API keys; this client just streams audio + control messages over WS. Works in browsers and on Node 22+ (uses the global WebSocket). |
webhookApprovalNotifier | value | (options: { url: string; headers?: Record<string, string>; fetch?: typeof fetch; }) => ApprovalNotifier | Runtime API for webhook approval notifier; the generated signature shows its accepted inputs and return type. |
WebhookSubscriptionContext | type | WebhookSubscriptionContext<TPayload> | Generic webhook subscription primitive — wakes an agent on inbound events from any external system (event bus, queue, scheduler, third-party SaaS webhook, your own application's domain events). fabric-harness consumes a JSON payload and dispatches to the user-provided handler. The host event system decides which payloads land here; fabric-harness has no opinion on event taxonomy or producer. |
WebhookSubscriptionDefinition | type | WebhookSubscriptionDefinition<TPayload> | Type contract for webhook subscription definition. |
withConversationProjection | value | (store: SessionStore, streams: ConversationStreamStore, options?: { producerId?: string; onError?: (error: unknown) => void; }) => SessionStore | Wrap a SessionStore so active-path appends are mirrored into an append-only ConversationStreamStore projection (v2 A4). The SessionEntry DAG stays the single source of truth; the stream gives clients offset-based catch-up + live tail. Two rules keep them coherent: 1. Idempotent by entryId — a crash between the DAG write and the stream write is repaired on the next append: the projector diffs the stream tail against the active path and re-emits anything missing. 2. Truncation is explicit — the DAG can branch (fork/replay/ checkpoint-restore rewrite leafId); the stream cannot. W... |
withFilesystemSources | value | (base: SandboxBackend | SandboxFactory | SandboxEnv, sources: MountedSource[]) => SandboxFactory | Runtime API for with filesystem sources; the generated signature shows its accepted inputs and return type. |
withIdleSuspend | value | (inner: SandboxEnv, options: SuspendingSandboxOptions | undefined) => SandboxEnv | Wrap any SandboxEnv with idle-based auto-suspend. Returns the inner env unchanged when idleSuspendMs is undefined or the inner env doesn't implement suspend(). |
WriteFileInput | type | WriteFileInput | Type contract for write file input. |
writeFileTool | value | (sandbox?: SandboxEnv) => ToolDef<WriteFileInput, void> | Model-callable tool or tool factory for write file. |
WsClientCommand | type | WsClientCommand | Type contract for ws client command. |
WsClientHandle | type | WsClientHandle | Type contract for ws client handle. |
WsClientOptions | type | WsClientOptions | Lightweight WebSocket client for the Node server's WS /sessions/:id/ws endpoint. Works in browsers and on Node 22+ (uses the global WebSocket). Does NOT depend on the ws package — that's the server side's optional peer dep. |
@fabric-harness/sdk/cloudflare
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
CloudflareR2BucketLike | type | CloudflareR2BucketLike | Type contract for cloudflare r2 bucket like. |
CloudflareR2ListResultLike | type | CloudflareR2ListResultLike | Type contract for cloudflare r2 list result like. |
CloudflareR2ObjectBodyLike | type | CloudflareR2ObjectBodyLike | Type contract for cloudflare r2 object body like. |
r2FilesystemSource | value | (bucket: CloudflareR2BucketLike, options?: R2FilesystemSourceOptions) => FilesystemSource | Read Cloudflare R2 objects as a Fabric filesystem source. Mount it with withFilesystemSources() (or getVirtualSandbox(...)) so agents can grep/read R2-backed knowledge bases through the normal sandbox tools. See the package declarations for an example. |
R2FilesystemSourceOptions | type | R2FilesystemSourceOptions | Configuration options for r2 filesystem source. |
@fabric-harness/sdk/channel
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
bytesToHex | value | (bytes: Uint8Array) => string | Runtime API for bytes to hex; the generated signature shows its accepted inputs and return type. |
Channel | type | Channel | Type contract for channel. |
ChannelContext | type | ChannelContext | Type contract for channel context. |
ChannelDispatch | type | ChannelDispatch | Type contract for channel dispatch. |
ChannelDispatchRequest | type | ChannelDispatchRequest | Input contract for channel dispatch. |
ChannelRoute | type | ChannelRoute | Channels turn platform webhooks (Slack, GitHub, …) into agent dispatches. Handlers are written against the Web Request/Response API and crypto.subtle, so the same channel runs on Node and Cloudflare. A channel is a stateless route container plus a conversation-id (de)serializer — session continuity falls out of the key (same thread → same key → same session). |
conversationKey | value | (provider: string, version: string, ...segments: string[]) => string | Runtime API for conversation key; the generated signature shows its accepted inputs and return type. |
defineChannel | value | (channel: Channel) => Channel | Validates and brands a channel's routes. |
defineTool | value | <TInput = unknown, TOutput = unknown>(tool: ToolDef<TInput, TOutput>) => ToolDef<TInput, TOutput> | Edge-safe identity helper equivalent to the root SDK's defineTool. |
hexToBytes | value | (hex: string) => Uint8Array | Runtime API for hex to bytes; the generated signature shows its accepted inputs and return type. |
hmacSha256 | value | (secret: string | Uint8Array, message: Uint8Array) => Promise<Uint8Array> | Runtime API for hmac sha256; the generated signature shows its accepted inputs and return type. |
parseConversationKey | value | (key: string) => ParsedConversationKey | Parses conversation key. |
ParsedConversationKey | type | ParsedConversationKey | Type contract for parsed conversation key. |
readJsonBody | value | (request: Request, limitBytes?: number) => Promise<RequestBody | undefined> | Reads the body once and returns the raw bytes, the decoded text, and the parsed JSON together — so a channel can HMAC-verify the exact bytes and use the JSON without re-reading the (already consumed) stream. Returns undefined only when the body exceeds limitBytes. |
readRequestBody | value | (request: Request, limitBytes?: number) => Promise<Uint8Array | undefined> | Reads the full request body as bytes, or returns undefined if it exceeds limitBytes. NOTE: this consumes the request stream (single read). Signature-verifying channels need the exact bytes for HMAC and the parsed JSON afterward — don't call request.json() as well. Use readJsonBody to get both from one read. |
RequestBody | type | RequestBody | Type contract for request body. |
ToolDef | type | ToolDef<TInput, TOutput> | Type contract for tool def. |
ToolEffect | type | ToolEffect | Type contract for tool effect. |
verifyHmacSha256 | value | (secret: string | Uint8Array, message: Uint8Array, signature: Uint8Array) => Promise<boolean> | Constant-time HMAC-SHA256 verification (via crypto.subtle.verify). |
@fabric-harness/sdk/conversation
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
ConversationMessage | type | ConversationMessage | Type contract for conversation message. |
ConversationMessageDisplay | type | ConversationMessageDisplay | Type contract for conversation message display. |
ConversationMessagePurpose | type | ConversationMessagePurpose | Type contract for conversation message purpose. |
ConversationMessageRole | type | ConversationMessageRole | Type contract for conversation message role. |
ConversationPart | type | ConversationPart | Type contract for conversation part. |
ConversationReply | type | ConversationReply | Type contract for conversation reply. |
ConversationSettlement | type | ConversationSettlement | Type contract for conversation settlement. |
ConversationSnapshot | type | ConversationSnapshot | Type contract for conversation snapshot. |
projectConversationRecords | value | (records: readonly ConversationStreamRecord[]) => ConversationSnapshot | Project canonical session records into a stable, UI-oriented protocol. |
readConversationReply | value | (snapshot: ConversationSnapshot, submissionId: string) => ConversationReply | Read the canonical assistant reply for a durable submission. Submission ids are used when available. The positional fallback supports conversations written by older Harness servers that predate submission correlation on individual entries. |
@fabric-harness/sdk/experimental
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
createPiAgentLoopRuntime | value | (options?: PiAgentLoopRuntimeOptions) => PiAgentLoopRuntime | Creates pi agent loop runtime. |
PiAgentLoopRuntime | value | typeof PiAgentLoopRuntime | Runtime API for pi agent loop runtime; the generated signature shows its accepted inputs and return type. |
PiAgentLoopRuntimeOptions | type | PiAgentLoopRuntimeOptions | Configuration options for pi agent loop runtime. |
PiCustomModel | type | PiCustomModel | Type contract for pi custom model. |
policiedSandboxEnv | value | (inner: SandboxEnv, policy: CapabilityPolicy | undefined) => SandboxEnv | Wrap a SandboxEnv with CapabilityPolicy enforcement at the sandbox layer. Without this decorator, agent code that calls (await session.sandbox).exec(...) directly bypasses the policy that session.shell() and tool dispatch enforce. policiedSandboxEnv() closes that gap by re-running the same policy evaluation against exec / readFile / writeFile / mkdir / rm / etc. Throws FabricError: - COMMAND_DENIED when an exec is denied or requires approval. - POLICY_DENIED when a filesystem op is denied or requires approval. The decorator does NOT auto-resolve requireApproval p... |
SuspendingSandboxEnv | value | typeof SuspendingSandboxEnv | Decorator that adds idle-based auto-suspend to any SandboxEnv whose underlying implementation supports suspend() / resume(). If the inner env doesn't implement them, the decorator is a no-op pass-through (the idle timer never fires anything). The decorator tracks a lastAccessAt timestamp on every operation. After idleSuspendMs elapses without activity, it calls inner.suspend(). The next operation transparently calls inner.resume() first (unless autoResumeOnAccess: false). cleanup() cancels the idle timer. |
SuspendingSandboxOptions | type | SuspendingSandboxOptions | Configuration options for suspending sandbox. |
withIdleSuspend | value | (inner: SandboxEnv, options: SuspendingSandboxOptions | undefined) => SandboxEnv | Wrap any SandboxEnv with idle-based auto-suspend. Returns the inner env unchanged when idleSuspendMs is undefined or the inner env doesn't implement suspend(). |
@fabric-harness/sdk/otel-observer
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
createOpenTelemetryObserver | value | (options?: OpenTelemetryObserverOptions) => FabricEventCallback | Creates open telemetry observer. |
OpenTelemetryObserverOptions | type | OpenTelemetryObserverOptions | Build a hierarchical OpenTelemetry trace from Fabric's event stream. Unlike openTelemetryExporter (which emits one flat span per duration-bearing event), this observer nests spans into a tree: prompt/skill operations contain turns, which contain tool / shell spans, with task sub-work nested under the active operation. The result is a single parent trace per operation that visualizes the full agent run. This module lives on the @fabric-harness/sdk/otel-observer subpath (not the main entry) because building parent contexts requires @opentelemetry/api at runtime; the main SDK... |
@fabric-harness/sdk/testing
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
MockModelProvider | value | typeof MockModelProvider | Provider implementation for mock model. |
StubFabricAgent | value | typeof StubFabricAgent | Runtime API for stub fabric agent; the generated signature shows its accepted inputs and return type. |
StubFabricSession | value | typeof StubFabricSession | Runtime API for stub fabric session; the generated signature shows its accepted inputs and return type. |
@fabric-harness/sdk/testing/contracts
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
AttachmentStoreContractHandle | type | AttachmentStoreContractHandle | Type contract for attachment store contract handle. |
ChannelContractDispatch | type | ChannelContractDispatch | Type contract for channel contract dispatch. |
ChannelContractFixture | type | ChannelContractFixture | Type contract for channel contract fixture. |
ChannelContractRequest | type | ChannelContractRequest | Input contract for channel contract. |
ConversationStreamStoreContractHandle | type | ConversationStreamStoreContractHandle | Type contract for conversation stream store contract handle. |
defineAttachmentStoreContractTests | value | (name: string, factory: () => Promise<AttachmentStoreContractHandle>) => void | Register the standard AttachmentStore contract tests under the given describe label. Each test gets a fresh store from factory(). |
defineChannelContractTests | value | (fixture: ChannelContractFixture) => void | Shared behavioral contract for first-party and community channel adapters. |
defineConversationStreamStoreContractTests | value | (name: string, factory: () => Promise<ConversationStreamStoreContractHandle>) => void | Register the standard ConversationStreamStore contract tests under the given describe label. Each test gets a fresh store from factory(). |
definePersistenceBundleContractTests | value | (name: string, factory: () => Promise<PersistenceBundleContractHandle>) => void | Compose all store contracts with bundle health, cost, run, and cascade checks. |
defineSubmissionStoreContractTests | value | (name: string, factory: () => Promise<SubmissionStoreContractHandle>) => void | Register the standard AgentSubmissionStore contract tests under the given describe label. Each test gets a fresh store from factory(). |
PersistenceBundleContractHandle | type | PersistenceBundleContractHandle | Type contract for persistence bundle contract handle. |
SubmissionStoreContractHandle | type | SubmissionStoreContractHandle | Type contract for submission store contract handle. |
@fabric-harness/temporal
@fabric-harness/temporal
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
ActivityIdempotency | type | ActivityIdempotency | Type contract for activity idempotency. |
ActivityTimeoutPolicy | type | ActivityTimeoutPolicy | Type contract for activity timeout policy. |
adaptSessionRuntime | value | (runtime: SessionRuntime, capabilities?: { dynamicAgents?: boolean; }) => DurableSessionRuntime | Adapt any SessionRuntime (Temporal-backed, Mock, or otherwise) into the SDK's DurableSessionRuntime shape. The two interfaces are structurally identical, but the type bridging keeps SDK types out of the temporal package's public API. |
AppendSessionEntryActivityInput | type | AppendSessionEntryActivityInput | Type contract for append session entry activity input. |
AppendSessionEntryActivityResult | type | AppendSessionEntryActivityResult | Result returned by append session entry activity. |
AppendSessionEventActivityInput | type | AppendSessionEventActivityInput | Type contract for append session event activity input. |
APPROVAL_SIGNAL | value | "approval" | Constant defining approval signal. |
approvalSignal | value | SignalDefinition<[ApprovalSignal], string> | Runtime API for approval signal; the generated signature shows its accepted inputs and return type. |
ApprovalSignal | type | ApprovalSignal | Type contract for approval signal. |
BuildContextActivityInput | type | BuildContextActivityInput | Type contract for build context activity input. |
BuildContextActivityResult | type | BuildContextActivityResult | Result returned by build context activity. |
CHECKPOINT_CREATE_WORKFLOW_NAME | value | "checkpointCreateWorkflow" | Constant defining checkpoint create workflow name. |
CHECKPOINT_RESTORE_WORKFLOW_NAME | value | "checkpointRestoreWorkflow" | Constant defining checkpoint restore workflow name. |
CheckpointActivityInput | type | CheckpointActivityInput | Type contract for checkpoint activity input. |
CheckpointActivityResult | type | CheckpointActivityResult | Result returned by checkpoint activity. |
checkpointCreateWorkflow | value | (input: SessionRuntimeCheckpointCreateInput & { sessionId: string; idempotency: { idempotencyKey: string; }; }) => Promise<import("@fabric-harness/sdk").CheckpointResult> | Runtime API for checkpoint create workflow; the generated signature shows its accepted inputs and return type. |
checkpointRestoreWorkflow | value | (input: SessionRuntimeCheckpointRestoreInput & { sessionId: string; idempotency: { idempotencyKey: string; }; }) => Promise<import("@fabric-harness/sdk").CheckpointResult> | Runtime API for checkpoint restore workflow; the generated signature shows its accepted inputs and return type. |
CompactSessionActivityInput | type | CompactSessionActivityInput | Type contract for compact session activity input. |
CompactSessionActivityResult | type | CompactSessionActivityResult | Result returned by compact session activity. |
connectTemporalWithRetry | value | <T>(connect: () => Promise<T>, options?: TemporalConnectRetryOptions) => Promise<T> | Runtime API for connect temporal with retry; the generated signature shows its accepted inputs and return type. |
createInlineSessionRuntime | value | (session: FabricSession) => SessionRuntime | Creates inline session runtime. |
createLocalTemporalActivities | value | (options: LocalTemporalActivitiesOptions) => TemporalActivities | Creates local temporal activities. |
createMockTemporalRuntime | value | (options?: MockTemporalRuntimeOptions) => MockTemporalRuntime | Creates mock temporal runtime. |
createTemporalClient | value | (options?: TemporalClientOptions) => Promise<TemporalClientHandle> | Creates temporal client. |
createTemporalClientConnectionOptions | value | (config?: TemporalConnectionConfig) => ConnectionOptions | Creates temporal client connection options. |
createTemporalDispatchActivities | value | (options: CreateTemporalDispatchActivitiesOptions) => TemporalDispatchActivities | Wrap a DispatchProcessor as a Temporal activity. The processor is idempotent by dispatchId, so Temporal retries are safe. |
CreateTemporalDispatchActivitiesOptions | type | CreateTemporalDispatchActivitiesOptions | Configuration options for create temporal dispatch activities. |
createTemporalSessionRuntimeActivities | value | (options: CreateTemporalSessionRuntimeActivitiesOptions) => TemporalSessionRuntimeActivities | Creates temporal session runtime activities. |
CreateTemporalSessionRuntimeActivitiesOptions | type | CreateTemporalSessionRuntimeActivitiesOptions | Configuration options for create temporal session runtime activities. |
createTemporalWorkerConnectionOptions | value | (config?: TemporalConnectionConfig) => NativeConnectionOptions | Creates temporal worker connection options. |
CUSTOM_APPROVAL_WORKFLOW_NAME | value | "customApprovalWorkflow" | Constant defining custom approval workflow name. |
customApprovalWorkflow | value | (input: CustomApprovalWorkflowInput) => Promise<ApprovalResponse | undefined> | Durable custom approval gate used by session.approval.request(). |
CustomApprovalWorkflowInput | type | CustomApprovalWorkflowInput | Type contract for custom approval workflow input. |
DEFAULT_TEMPORAL_ACTIVITY_TIMEOUTS | value | TemporalActivityTimeouts | Constant defining default temporal activity timeouts. |
DEFAULT_TEMPORAL_ADDRESS | value | "localhost:7233" | Default Temporal frontend address used by CLI / build scaffolds when nothing is configured. |
DEFAULT_TEMPORAL_NAMESPACE | value | "default" | Default namespace. |
DEFAULT_TEMPORAL_TASK_QUEUE | value | "fabric-harness" | Default task queue name. |
defineTemporalAgent | value | (options?: DefineTemporalAgentOptions) => DefinedAgent<JsonObject, unknown> | Defines temporal agent. |
DefineTemporalAgentOptions | type | DefineTemporalAgentOptions | Configuration options for define temporal agent. |
DISPATCH_WORKFLOW_NAME | value | "dispatchWorkflow" | Constant defining dispatch workflow name. |
dispatchWorkflow | value | (input: DispatchInput) => Promise<void> | Durable dispatch: applies one dispatched input to a persistent instance via the processDispatch activity. The activity is idempotent by dispatchId, so Temporal retries (and worker restarts) won't double-apply. |
ExecuteToolActivityInput | type | ExecuteToolActivityInput | Type contract for execute tool activity input. |
ExecuteToolActivityResult | type | ExecuteToolActivityResult | Result returned by execute tool activity. |
HYBRID_PROMPT_WORKFLOW_NAME | value | "hybridPromptWorkflow" | Constant defining hybrid prompt workflow name. |
hybridPromptWorkflow | value | (input: PromptWorkflowInput, sharedEventState?: EventIndexState) => Promise<PromptWorkflowResult> | Hybrid durable prompt workflow. The workflow owns deterministic turn orchestration while activities perform nondeterministic effects: context construction, model calls, tool execution, approval policy checks, and durable entry/event appends. |
InlineSessionRuntime | value | typeof InlineSessionRuntime | Runtime API for inline session runtime; the generated signature shows its accepted inputs and return type. |
LoadSessionActivityInput | type | LoadSessionActivityInput | Type contract for load session activity input. |
LocalTemporalActivitiesOptions | type | LocalTemporalActivitiesOptions | Configuration options for local temporal activities. |
MockTemporalClient | value | typeof MockTemporalClient | Minimal mock Temporal client that satisfies enough of the TemporalClientHandle interface for agent tests. Delegates SessionRuntime calls to MockTemporalRuntime. |
MockTemporalModelProvider | value | typeof MockTemporalModelProvider | Minimal mock model provider for Temporal agent tests. Returns deterministic responses based on the latest user message. |
MockTemporalRuntime | value | typeof MockTemporalRuntime | Runtime API for mock temporal runtime; the generated signature shows its accepted inputs and return type. |
MockTemporalRuntimeOptions | type | MockTemporalRuntimeOptions | Configuration options for mock temporal runtime. |
ModelGenerateActivityInput | type | ModelGenerateActivityInput | Type contract for model generate activity input. |
ModelGenerateActivityResult | type | ModelGenerateActivityResult | Result returned by model generate activity. |
PendingApprovalState | type | PendingApprovalState | Type contract for pending approval state. |
PROMPT_WORKFLOW_NAME | value | "promptWorkflow" | Constant defining prompt workflow name. |
promptWorkflow | value | (input: PromptWorkflowInput) => Promise<PromptWorkflowResult> | Coarse one-shot prompt workflow. Useful as a compatibility path while the hybrid loop is still gaining lower-level activity implementations. |
PromptWorkflowInput | type | PromptWorkflowInput | Type contract for prompt workflow input. |
PromptWorkflowResult | type | PromptWorkflowResult | Result returned by prompt workflow. |
requireIdempotency | value | (input: { idempotency?: ActivityIdempotency; }, activityName: string) => ActivityIdempotency | Runtime API for require idempotency; the generated signature shows its accepted inputs and return type. |
ResolvedTemporalConnectionConfig | type | ResolvedTemporalConnectionConfig | Type contract for resolved temporal connection config. |
ResolveSecretActivityInput | type | ResolveSecretActivityInput | Type contract for resolve secret activity input. |
resolveTemporalConnectionConfig | value | (options?: TemporalConnectionConfig) => ResolvedTemporalConnectionConfig | Resolves temporal connection config. |
resolveToolRefs | value | (bundle: TemporalBundle, refs: string[]) => ToolDef[] | Resolves tool refs. |
RuntimeCheckpointCreateActivityInput | type | RuntimeCheckpointCreateActivityInput | Type contract for runtime checkpoint create activity input. |
RuntimeCheckpointRestoreActivityInput | type | RuntimeCheckpointRestoreActivityInput | Type contract for runtime checkpoint restore activity input. |
RuntimePromptActivityInput | type | RuntimePromptActivityInput | Type contract for runtime prompt activity input. |
RuntimeShellActivityInput | type | RuntimeShellActivityInput | Type contract for runtime shell activity input. |
SESSION_STATE_QUERY | value | "sessionState" | Constant defining session state query. |
SessionRuntime | type | SessionRuntime | Type contract for session runtime. |
SessionRuntimeApprovalInput | type | SessionRuntimeApprovalInput | Type contract for session runtime approval input. |
SessionRuntimeCheckpointCreateInput | type | SessionRuntimeCheckpointCreateInput | Type contract for session runtime checkpoint create input. |
SessionRuntimeCheckpointRestoreInput | type | SessionRuntimeCheckpointRestoreInput | Type contract for session runtime checkpoint restore input. |
SessionRuntimeFactory | type | SessionRuntimeFactory | Factory for session runtime. |
SessionRuntimePromptInput | type | SessionRuntimePromptInput<TResult> | Type contract for session runtime prompt input. |
SessionRuntimeShellInput | type | SessionRuntimeShellInput | Type contract for session runtime shell input. |
SessionRuntimeTaskInput | type | SessionRuntimeTaskInput<TResult> | Type contract for session runtime task input. |
sessionStateQuery | value | QueryDefinition<TemporalWorkflowQueryState, [], string> | Runtime API for session state query; the generated signature shows its accepted inputs and return type. |
sessionWorkflow | value | (input: TemporalSessionWorkflowInput) => Promise<void> | Long-lived session coordination workflow. This first production Temporal integration supports approval signaling and state queries. Prompt/shell/checkpoint operations are workflows below. |
SessionWorkflowDefinition | type | SessionWorkflowDefinition | Type contract for session workflow definition. |
SHELL_WORKFLOW_NAME | value | "shellWorkflow" | Constant defining shell workflow name. |
shellWorkflow | value | (input: SessionRuntimeShellInput & { sessionId: string; idempotency: { idempotencyKey: string; }; }) => Promise<import("@fabric-harness/sdk").ShellResult> | Runtime API for shell workflow; the generated signature shows its accepted inputs and return type. |
SnapshotRef | type | SnapshotRef | Type contract for snapshot ref. |
startTemporalWorker | value | (options?: TemporalWorkerOptions) => Promise<TemporalWorkerHandle> | Runtime API for start temporal worker; the generated signature shows its accepted inputs and return type. |
TASK_WORKFLOW_NAME | value | "taskWorkflow" | Constant defining task workflow name. |
taskWorkflow | value | (input: TaskWorkflowInput) => Promise<PromptWorkflowResult> | Runtime API for task workflow; the generated signature shows its accepted inputs and return type. |
TaskWorkflowInput | type | TaskWorkflowInput | Type contract for task workflow input. |
temporal | value | (config: TemporalBundleConfig) => Promise<TemporalBundle> | Runtime API for temporal; the generated signature shows its accepted inputs and return type. |
TemporalActivities | type | TemporalActivities | Type contract for temporal activities. |
TemporalActivityTimeouts | type | TemporalActivityTimeouts | Type contract for temporal activity timeouts. |
TemporalBundle | type | TemporalBundle | Type contract for temporal bundle. |
TemporalBundleConfig | type | TemporalBundleConfig | Type contract for temporal bundle config. |
TemporalClientHandle | type | TemporalClientHandle | Type contract for temporal client handle. |
TemporalClientOptions | type | TemporalClientOptions | Configuration options for temporal client. |
TemporalConnectionConfig | type | TemporalConnectionConfig | Type contract for temporal connection config. |
TemporalConnectRetryOptions | type | TemporalConnectRetryOptions | Configuration options for temporal connect retry. |
TemporalDispatchActivities | type | TemporalDispatchActivities | Activity that durably applies a dispatched input to a persistent instance. |
TemporalDispatchClientLike | type | TemporalDispatchClientLike | Minimal Temporal client surface needed to start a dispatch workflow. |
temporalDispatchQueue | value | (options: TemporalDispatchQueueOptions) => DispatchQueue | Durable dispatch queue. enqueue starts a dispatchWorkflow keyed by the dispatchId, so delivery survives worker/process restarts and a duplicate dispatchId maps to the same workflow id (idempotent admission). Implements the SDK's DispatchQueue; pair with createTemporalDispatchActivities on the worker. When runtime: 'temporal' is configured, this is the default dispatch queue (D4) unless an explicit queue is supplied. |
TemporalDispatchQueueOptions | type | TemporalDispatchQueueOptions | Configuration options for temporal dispatch queue. |
TemporalIntegrationMode | type | TemporalIntegrationMode | Type contract for temporal integration mode. |
TemporalPromptWorkflowMode | type | TemporalPromptWorkflowMode | Type contract for temporal prompt workflow mode. |
TemporalRunStatus | type | TemporalRunStatus | Type contract for temporal run status. |
TemporalRuntimeOptions | type | TemporalRuntimeOptions | Configuration options for temporal runtime. |
temporalSessionRuntime | value | (options?: TemporalClientOptions) => DurableSessionRuntimeFactory | Build a DurableSessionRuntimeFactory for init({ sessionRuntime }) that delegates each session's prompt/task/shell/checkpoint calls to a Temporal workflow. The Temporal client connection is opened lazily on the first session and shared across all sessions produced by this factory. Pair with runtime: 'temporal' for production deployments. For tests, pass mode: 'mock' to use the in-process mock runtime. See the package declarations for an example. |
TemporalSessionRuntime | value | typeof TemporalSessionRuntime | Runtime API for temporal session runtime; the generated signature shows its accepted inputs and return type. |
TemporalSessionRuntimeActivities | type | TemporalSessionRuntimeActivities | Type contract for temporal session runtime activities. |
TemporalSessionWorkflowInput | type | TemporalSessionWorkflowInput | Type contract for temporal session workflow input. |
TemporalSignalClient | type | TemporalSignalClient | Client implementation for temporal signal. |
TemporalTlsConfig | type | TemporalTlsConfig | Type contract for temporal tls config. |
TemporalWorkerHandle | type | TemporalWorkerHandle | Type contract for temporal worker handle. |
TemporalWorkerOptions | type | TemporalWorkerOptions | Configuration options for temporal worker. |
TemporalWorkflowQueryState | type | TemporalWorkflowQueryState | Type contract for temporal workflow query state. |
ToolApprovalRequest | type | ToolApprovalRequest | Input contract for tool approval. |
@fabric-harness/temporal/agent
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
defineTemporalAgent | value | (options?: DefineTemporalAgentOptions) => DefinedAgent<JsonObject, unknown> | Defines temporal agent. |
DefineTemporalAgentOptions | type | DefineTemporalAgentOptions | Configuration options for define temporal agent. |
resolveToolRefs | value | (bundle: TemporalBundle, refs: string[]) => ToolDef[] | Resolves tool refs. |
temporal | value | (config: TemporalBundleConfig) => Promise<TemporalBundle> | Runtime API for temporal; the generated signature shows its accepted inputs and return type. |
TemporalBundle | type | TemporalBundle | Type contract for temporal bundle. |
TemporalBundleConfig | type | TemporalBundleConfig | Type contract for temporal bundle config. |
@fabric-harness/vite
@fabric-harness/vite
| Export | Kind | TypeScript signature | Purpose |
|---|---|---|---|
fabricHarness | value | (options?: FabricHarnessViteOptions) => Plugin | Compose Harness with Vite without replacing fh dev, fh build, explicit agent builders, or the portable target registry. |
FabricHarnessViteApi | type | FabricHarnessViteApi | Type contract for fabric harness vite api. |
FabricHarnessViteOptions | type | FabricHarnessViteOptions | Configuration options for fabric harness vite. |
fabricHarnessWorkerConfig | value | () => FabricHarnessWorkerConfigCustomizer | Narrow customizer for @cloudflare/vite-plugin. It contributes only the Harness-generated worker entry and node compatibility flag; user bindings, migrations, and deployment settings remain untouched. |
FabricHarnessWorkerConfigCustomizer | type | FabricHarnessWorkerConfigCustomizer | Type contract for fabric harness worker config customizer. |