Interface: PrefactorProvider\<TMiddleware\>
Prefactor TypeScript SDK / @prefactor/core / PrefactorProvider
Interface: PrefactorProvider<TMiddleware>
Section titled “Interface: PrefactorProvider<TMiddleware>”Defined in: packages/core/src/client.ts:32
Provider integration contract for Prefactor SDK clients.
Type Parameters
Section titled “Type Parameters”TMiddleware
Section titled “TMiddleware”TMiddleware = MiddlewareLike
Methods
Section titled “Methods”createMiddleware()
Section titled “createMiddleware()”createMiddleware(
tracer,agentManager,config):TMiddleware
Defined in: packages/core/src/client.ts:41
Creates provider middleware bound to the core runtime services.
Parameters
Section titled “Parameters”tracer
Section titled “tracer”Runtime tracer used for span creation.
agentManager
Section titled “agentManager”Runtime agent instance manager.
config
Section titled “config”Resolved SDK configuration.
transportType
Section titled “transportType”"http" = ...
Transport type to use for span emission
sampleRate
Section titled “sampleRate”number = ...
Sampling rate (0.0 to 1.0)
captureInputs
Section titled “captureInputs”boolean = ...
Whether to capture span inputs
captureOutputs
Section titled “captureOutputs”boolean = ...
Whether to capture span outputs
maxInputLength
Section titled “maxInputLength”number = ...
Maximum length for input strings
maxOutputLength
Section titled “maxOutputLength”number = ...
Maximum length for output strings
httpConfig?
Section titled “httpConfig?”{ apiUrl: string; apiToken: string; agentId?: string; agentIdentifier?: string; agentName?: string; agentDescription?: string; agentSchema?: Record<string, unknown>; requestTimeout?: number; maxRetries?: number; initialRetryDelay?: number; maxRetryDelay?: number; retryMultiplier?: number; retryOnStatusCodes?: number[]; } = ...
HTTP transport configuration (required if transportType is ‘http’)
httpConfig.apiUrl
Section titled “httpConfig.apiUrl”string = ...
httpConfig.apiToken
Section titled “httpConfig.apiToken”string = ...
httpConfig.agentId?
Section titled “httpConfig.agentId?”string = ...
httpConfig.agentIdentifier?
Section titled “httpConfig.agentIdentifier?”string = ...
httpConfig.agentName?
Section titled “httpConfig.agentName?”string = ...
httpConfig.agentDescription?
Section titled “httpConfig.agentDescription?”string = ...
httpConfig.agentSchema?
Section titled “httpConfig.agentSchema?”Record<string, unknown> = ...
httpConfig.requestTimeout?
Section titled “httpConfig.requestTimeout?”number = ...
httpConfig.maxRetries?
Section titled “httpConfig.maxRetries?”number = ...
httpConfig.initialRetryDelay?
Section titled “httpConfig.initialRetryDelay?”number = ...
httpConfig.maxRetryDelay?
Section titled “httpConfig.maxRetryDelay?”number = ...
httpConfig.retryMultiplier?
Section titled “httpConfig.retryMultiplier?”number = ...
httpConfig.retryOnStatusCodes?
Section titled “httpConfig.retryOnStatusCodes?”number[] = ...
failureHandling?
Section titled “failureHandling?”{ onFatalError?: (error) => void; } = ...
Optional failure handling callbacks.
failureHandling.onFatalError?
Section titled “failureHandling.onFatalError?”(error) => void = ...
Returns
Section titled “Returns”TMiddleware
Provider middleware consumed by upstream frameworks.
Properties
Section titled “Properties”shutdown()?
Section titled “shutdown()?”
optionalshutdown: () =>void|Promise<void>
Defined in: packages/core/src/client.ts:45
Optional provider-level cleanup hook invoked during client shutdown.
Returns
Section titled “Returns”void | Promise<void>
getSdkHeaderEntry()?
Section titled “getSdkHeaderEntry()?”
optionalgetSdkHeaderEntry: () =>string|undefined
Defined in: packages/core/src/client.ts:51
Returns the SDK header entry to append to HTTP requests created by the core runtime.
Returns
Section titled “Returns”string | undefined
Adapter-specific SDK identifier, or undefined to use the core header only.
normalizeAgentSchema()?
Section titled “normalizeAgentSchema()?”
optionalnormalizeAgentSchema: (agentSchema) =>Record<string,unknown> |undefined
Defined in: packages/core/src/client.ts:58
Normalizes a user- or provider-authored agent schema before core registers it.
Parameters
Section titled “Parameters”agentSchema
Section titled “agentSchema”Record<string, unknown>
Authored agent schema configuration.
Returns
Section titled “Returns”Record<string, unknown> | undefined
Normalized schema, or undefined to leave the input unchanged.
getDefaultAgentSchema()?
Section titled “getDefaultAgentSchema()?”
optionalgetDefaultAgentSchema: () =>Record<string,unknown> |undefined
Defined in: packages/core/src/client.ts:66
Provides a default agent schema when a user does not supply one.
Returns
Section titled “Returns”Record<string, unknown> | undefined
Agent schema object, or undefined when no default is available.