@fungi.computer/forage

Classes

ForageError

A bounded, machine-readable failure at a Forage public seam.

Extends

Error

Constructors

Constructor

new ForageError(code, message): ForageError

Parameters

code

"empty_query" | "empty_catalog" | "unknown_target" | "duplicate_operation" | "invalid_input"

message

string

Returns

ForageError

Overrides

Error.constructor

Properties

code

readonly code: "empty_query" | "empty_catalog" | "unknown_target" | "duplicate_operation" | "invalid_input"

failure

readonly failure: object

code

code: "empty_query" | "empty_catalog" | "unknown_target" | "duplicate_operation" | "invalid_input"

message

message: string

Type Aliases

ForageCatalog

ForageCatalog = Readonly<{ revision: string; search: (rawInput) => SearchOutput; describe: (rawInput) => DescribeOutput; stamp: () => string; }>

Immutable public facade for one prepared catalog revision.

ForageDefinition

ForageDefinition = Readonly<{ path: string; description: string; input: typeof forageSearchInput | typeof forageDescribeInput; output: typeof searchOutputSchema | typeof describeOutputSchema; }>

Structural operation definition consumed by a capability composer.

ForageApi

ForageApi = object

Public convenience namespace contract.

Properties

createCatalog

createCatalog: typeof createCatalog

Construct one immutable catalog revision.

forageSearchDefinition

forageSearchDefinition: typeof forageSearchDefinition

Structural search operation definition.

forageDescribeDefinition

forageDescribeDefinition: typeof forageDescribeDefinition

Structural description operation definition.

ForageSearchInput

ForageSearchInput = z.input<typeof forageSearchInput>>

Parsed search request type.

ForageDescribeInput

ForageDescribeInput = z.input<typeof forageDescribeInput>>

Parsed description request type.

SearchResult

SearchResult = z.infer<typeof searchResultSchema>>

One ranked search result type.

SearchOutput

SearchOutput = z.infer<typeof searchOutputSchema>>

Search response envelope type.

DescribeOutput

DescribeOutput = z.infer<typeof describeOutputSchema>>

Description response type.

ForageFailure

ForageFailure = z.infer<typeof forageFailureSchema>>

Typed failure value type.

Operation

Operation = z.infer<typeof operationSchema>>

Catalog operation descriptor type.

CatalogInput

CatalogInput = z.input<typeof catalogInputSchema>>

Catalog construction input type.

Variables

forageSearchDefinition

const forageSearchDefinition: ForageDefinition

The search operation has schema metadata only; it has no host behavior.

forageDescribeDefinition

const forageDescribeDefinition: ForageDefinition

The description operation has schema metadata only; it has no host behavior.

Forage

const Forage: ForageApi

Narrow convenience namespace for the package’s public seams.

forageSearchInput

const forageSearchInput: ZodObject<{ query: ZodString; maxResults: ZodDefault<ZodNumber>>; }, $strip>>

Input accepted by the pure catalog search seam.

forageDescribeInput

const forageDescribeInput: ZodObject<{ path: ZodString; detail: ZodDefault<ZodEnum<{ index: "index"; full: "full"; }>>; methods: ZodOptional<ZodArray<ZodString>>>>; }, $strip>>

Input accepted by the pure catalog description seam.

searchResultSchema

const searchResultSchema: ZodObject<{ path: ZodString; description: ZodOptional<ZodString>>; score: ZodNumber; matchReason: ZodOptional<ZodString>>; sample: ZodOptional<ZodRecord<ZodString, ZodJSONSchema>>>>; capabilityNotes: ZodOptional<ZodString>>; peers: ZodOptional<ZodArray<ZodObject<{ path: ZodString; capabilityNotes: ZodOptional<ZodString>>; }, $strip>>>>>>; }, $strip>>

One ranked operation in a search response.

searchOutputSchema

const searchOutputSchema: ZodObject<{ results: ZodArray<ZodObject<{ path: ZodString; description: ZodOptional<ZodString>>; score: ZodNumber; matchReason: ZodOptional<ZodString>>; sample: ZodOptional<ZodRecord<ZodString, ZodJSONSchema>>>>; capabilityNotes: ZodOptional<ZodString>>; peers: ZodOptional<ZodArray<ZodObject<{ path: ZodString; capabilityNotes: ZodOptional<ZodString>>; }, $strip>>>>>>; }, $strip>>>>; total: ZodNumber; truncated: ZodBoolean; topScore: ZodNumber; margin: ZodNumber; catalogStamp: ZodString; }, $strip>>

Bounded search response envelope.

describeOutputSchema

const describeOutputSchema: ZodObject<{ path: ZodString; description: ZodOptional<ZodString>>; types: ZodString; kind: ZodEnum<{ module: "module"; operation: "operation"; }>; usage: ZodOptional<ZodString>>; }, $strip>>

Deterministic description response.

forageFailureSchema

const forageFailureSchema: ZodObject<{ code: ZodEnum<{ empty_query: "empty_query"; empty_catalog: "empty_catalog"; unknown_target: "unknown_target"; duplicate_operation: "duplicate_operation"; invalid_input: "invalid_input"; }>; message: ZodString; }, $strip>>

Closed failure vocabulary for malformed or absent catalog requests.

operationSchema

const operationSchema: ZodObject<{ path: ZodString; description: ZodOptional<ZodString>>; input: ZodCustom<ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>>>, ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>>>>>; output: ZodOptional<ZodCustom<ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>>>, ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>>>>>>>; capabilityNotes: ZodOptional<ZodString>>; instructions: ZodOptional<ZodString>>; }, $strip>>

A secret-free, callback-free operation descriptor.

catalogInputSchema

const catalogInputSchema: ZodObject<{ revision: ZodString; operations: ZodArray<ZodObject<{ path: ZodString; description: ZodOptional<ZodString>>; input: ZodCustom<ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>>>, ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>>>>>; output: ZodOptional<ZodCustom<ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>>>, ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>>>>>>>; capabilityNotes: ZodOptional<ZodString>>; instructions: ZodOptional<ZodString>>; }, $strip>>>>; }, $strip>>

Input used to construct one immutable catalog revision.

Functions

createCatalog()

createCatalog(input): ForageCatalog

Construct one immutable catalog revision with a narrow public facade.

Parameters

input

revision

string = ...

operations

object[] = ...

Returns

ForageCatalog

References

default

Renames and re-exports Forage