@codesoul-co/hypha-memory / provider-return-evidence

• Package index: @codesoul-co/hypha-memory
• Source: packages/memory/src/provider-return-evidence.ts
• Exports: 6

Using this module

Use the Provider return evidence module for binding external or local providers to Hypha ports. It exports 1 constant, 2 functions, 3 interfaces.

Import from the package entrypoint

import {
  memoryProviderReturnEvidenceSchema,
  createMemoryProviderReturnEvidence,
  verifyMemoryProviderReturnEvidence,
} from '@codesoul-co/hypha-memory';

import type {
  MemoryProviderEvidenceContext,
  MemoryProviderRecordBinding,
  MemoryProviderReturnEvidence,
} from '@codesoul-co/hypha-memory';

Usage patterns

• Use the 3 type/interface exports as static contracts in application code, adapters, or tests. Import them with import type; they do not exist at runtime.
• The module exposes 2 functions as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.
• The 1 constant/enum export provides stable values, schemas, definitions, or defaults. Reuse these exports instead of copying internal values into an application.

Public exports

Symbol	Kind	Signature	Description
memoryProviderReturnEvidenceSchema	constant	const memoryProviderReturnEvidenceSchema: ZodType<MemoryProviderReturnEvidence, ZodTypeDef, MemoryProviderReturnEvidence>	Runtime schema for Memory Provider Return Evidence.
createMemoryProviderReturnEvidence	function	createMemoryProviderReturnEvidence(context: MemoryProviderEvidenceContext): MemoryProviderReturnEvidence	Create Memory Provider Return Evidence function with 1 public call signature; parameters and return types are listed below.
verifyMemoryProviderReturnEvidence	function	verifyMemoryProviderReturnEvidence(evidence: unknown, context: Omit<MemoryProviderEvidenceContext, "status" | "error">): MemoryProviderReturnEvidence	Verify Memory Provider Return Evidence function with 1 public call signature; parameters and return types are listed below.
MemoryProviderEvidenceContext	interface	interface MemoryProviderEvidenceContext	Memory Provider Evidence Context interface with 10 public fields or methods.
MemoryProviderRecordBinding	interface	interface MemoryProviderRecordBinding	Memory Provider Record Binding interface with 5 public fields or methods.
MemoryProviderReturnEvidence	interface	interface MemoryProviderReturnEvidence	Memory Provider Return Evidence interface with 12 public fields or methods.

memoryProviderReturnEvidenceSchema

Runtime schema for Memory Provider Return Evidence.

• Kind: constant
• Import: import { memoryProviderReturnEvidenceSchema } from '@codesoul-co/hypha-memory';
• Source module: provider-return-evidence

Declaration

export declare const memoryProviderReturnEvidenceSchema: ZodType<MemoryProviderReturnEvidence, ZodTypeDef, MemoryProviderReturnEvidence>;

createMemoryProviderReturnEvidence

Create Memory Provider Return Evidence function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { createMemoryProviderReturnEvidence } from '@codesoul-co/hypha-memory';
• Source module: provider-return-evidence

Declaration

export declare function createMemoryProviderReturnEvidence(context: MemoryProviderEvidenceContext): MemoryProviderReturnEvidence;

Call signature

createMemoryProviderReturnEvidence(context: MemoryProviderEvidenceContext): MemoryProviderReturnEvidence

Parameters

Parameter	Type	Required	Description
context	MemoryProviderEvidenceContext	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: MemoryProviderReturnEvidence
• Description: The return contract is defined by the type shown above.

verifyMemoryProviderReturnEvidence

Verify Memory Provider Return Evidence function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { verifyMemoryProviderReturnEvidence } from '@codesoul-co/hypha-memory';
• Source module: provider-return-evidence

Declaration

export declare function verifyMemoryProviderReturnEvidence(evidence: unknown, context: Omit<MemoryProviderEvidenceContext, 'status' | 'error'>): MemoryProviderReturnEvidence;

Call signature

verifyMemoryProviderReturnEvidence(evidence: unknown, context: Omit<MemoryProviderEvidenceContext, "status" | "error">): MemoryProviderReturnEvidence

Parameters

Parameter	Type	Required	Description
evidence	unknown	Yes	Required parameter; accepted values are defined by the type column.
context	Omit<MemoryProviderEvidenceContext, "status" | "error">	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: MemoryProviderReturnEvidence
• Description: The return contract is defined by the type shown above.

MemoryProviderEvidenceContext

Memory Provider Evidence Context interface with 10 public fields or methods.

• Kind: interface
• Import: import type { MemoryProviderEvidenceContext } from '@codesoul-co/hypha-memory';
• Source module: provider-return-evidence

Declaration

export interface MemoryProviderEvidenceContext {
    operationId: string;
    operation: MemoryActivityOperation;
    principal: MemoryPrincipal;
    scope: ManagedMemoryScope;
    providerId: string;
    providerRevision?: string;
    input: unknown;
    output: unknown;
    status: MemoryProviderReturnEvidence['terminal']['status'];
    error?: NormalizedMemoryError;
}

Contract members

Member	Kind	Signature	Description
error	property	error?: NormalizedMemoryError	Public property; its type, readonly modifier and optionality are shown in the signature.
input	property	input: unknown	Public property; its type, readonly modifier and optionality are shown in the signature.
operation	property	operation: MemoryActivityOperation	Public property; its type, readonly modifier and optionality are shown in the signature.
operationId	property	operationId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
output	property	output: unknown	Public property; its type, readonly modifier and optionality are shown in the signature.
principal	property	principal: MemoryPrincipal	Public property; its type, readonly modifier and optionality are shown in the signature.
providerId	property	providerId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
providerRevision	property	providerRevision?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
scope	property	scope: ManagedMemoryScope	Public property; its type, readonly modifier and optionality are shown in the signature.
status	property	status: "completed" | "cancelled" | "failed" | "partial"	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryProviderRecordBinding

Memory Provider Record Binding interface with 5 public fields or methods.

• Kind: interface
• Import: import type { MemoryProviderRecordBinding } from '@codesoul-co/hypha-memory';
• Source module: provider-return-evidence

Declaration

export interface MemoryProviderRecordBinding {
    memoryId: string;
    versionId: string;
    revision: number;
    scopeHash: string;
    providerId: string;
}

Contract members

Member	Kind	Signature	Description
memoryId	property	memoryId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
providerId	property	providerId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
revision	property	revision: number	Public property; its type, readonly modifier and optionality are shown in the signature.
scopeHash	property	scopeHash: string	Public property; its type, readonly modifier and optionality are shown in the signature.
versionId	property	versionId: string	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryProviderReturnEvidence

Memory Provider Return Evidence interface with 12 public fields or methods.

• Kind: interface
• Import: import type { MemoryProviderReturnEvidence } from '@codesoul-co/hypha-memory';
• Source module: provider-return-evidence

Declaration

export interface MemoryProviderReturnEvidence {
    schemaVersion: '1.0';
    operationId: string;
    operation: MemoryActivityOperation;
    inputHash: string;
    principalHash: string;
    scopeHash: string;
    providerId: string;
    providerRevision?: string;
    outputHash: string;
    recordBindings: MemoryProviderRecordBinding[];
    terminal: {
        status: 'completed' | 'partial' | 'failed' | 'cancelled';
        error?: NormalizedMemoryError;
    };
    proofHash: string;
}

Contract members

Member	Kind	Signature	Description
inputHash	property	inputHash: string	Public property; its type, readonly modifier and optionality are shown in the signature.
operation	property	operation: MemoryActivityOperation	Public property; its type, readonly modifier and optionality are shown in the signature.
operationId	property	operationId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
outputHash	property	outputHash: string	Public property; its type, readonly modifier and optionality are shown in the signature.
principalHash	property	principalHash: string	Public property; its type, readonly modifier and optionality are shown in the signature.
proofHash	property	proofHash: string	Public property; its type, readonly modifier and optionality are shown in the signature.
providerId	property	providerId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
providerRevision	property	providerRevision?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
recordBindings	property	recordBindings: MemoryProviderRecordBinding[]	Public property; its type, readonly modifier and optionality are shown in the signature.
schemaVersion	property	schemaVersion: "1.0"	Public property; its type, readonly modifier and optionality are shown in the signature.
scopeHash	property	scopeHash: string	Public property; its type, readonly modifier and optionality are shown in the signature.
terminal	property	terminal: { status: "completed" | "partial" | "failed" | "cancelled"; error?: NormalizedMemoryError; }	Public property; its type, readonly modifier and optionality are shown in the signature.