@codesoul-co/hypha-memory / integration-schema

• Package index: @codesoul-co/hypha-memory
• Source: packages/memory/src/integration-schema.ts
• Exports: 21

Using this module

Use the Integration schema module for declaring and runtime-validating contracts. It exports 13 constants, 8 functions.

Import from the package entrypoint

import {
  domainMemoryDependencySnapshotSchema,
  memoryCacheInvalidationSchema,
  memoryCacheValidityInputExample,
  memoryCacheValidityInputSchema,
  memoryEvaluationCaseExample,
  memoryEvaluationCaseSchema,
  memoryEvaluationObservationSchema,
  memoryReplayReferenceExample,
} from '@codesoul-co/hypha-memory';

// The complete export list is documented below.

Usage patterns

• The module exposes 8 functions as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.
• The 13 constant/enum exports provide stable values, schemas, definitions, or defaults. Reuse these exports instead of copying internal values into an application.

Public exports

Symbol	Kind	Signature	Description
domainMemoryDependencySnapshotSchema	constant	const domainMemoryDependencySnapshotSchema: ZodType<DomainMemoryDependencySnapshot, ZodTypeDef, DomainMemoryDependencySnapshot>	Runtime schema for Domain Memory Dependency Snapshot.
memoryCacheInvalidationSchema	constant	const memoryCacheInvalidationSchema: ZodType<MemoryCacheInvalidation, ZodTypeDef, MemoryCacheInvalidation>	Runtime schema for Memory Cache Invalidation.
memoryCacheValidityInputExample	constant	const memoryCacheValidityInputExample: MemoryCacheValidityInput	Valid example value for Memory Cache Validity Input.
memoryCacheValidityInputSchema	constant	const memoryCacheValidityInputSchema: ZodType<MemoryCacheValidityInput, ZodTypeDef, MemoryCacheValidityInput>	Runtime schema for Memory Cache Validity Input.
memoryEvaluationCaseExample	constant	const memoryEvaluationCaseExample: MemoryEvaluationCase	Valid example value for Memory Evaluation Case.
memoryEvaluationCaseSchema	constant	const memoryEvaluationCaseSchema: ZodType<MemoryEvaluationCase, ZodTypeDef, MemoryEvaluationCase>	Runtime schema for Memory Evaluation Case.
memoryEvaluationObservationSchema	constant	const memoryEvaluationObservationSchema: ZodType<MemoryEvaluationObservation, ZodTypeDef, MemoryEvaluationObservation>	Runtime schema for Memory Evaluation Observation.
memoryReplayReferenceExample	constant	const memoryReplayReferenceExample: MemoryReplayReference	Valid example value for Memory Replay Reference.
memoryReplayReferenceSchema	constant	const memoryReplayReferenceSchema: ZodType<MemoryReplayReference, ZodTypeDef, MemoryReplayReference>	Runtime schema for Memory Replay Reference.
sessionMemoryBindingExample	constant	const sessionMemoryBindingExample: SessionMemoryBinding	Valid example value for Session Memory Binding.
sessionMemoryBindingSchema	constant	const sessionMemoryBindingSchema: ZodType<SessionMemoryBinding, ZodTypeDef, SessionMemoryBinding>	Runtime schema for Session Memory Binding.
workflowStateMemoryBindingExample	constant	const workflowStateMemoryBindingExample: WorkflowStateMemoryBinding	Valid example value for Workflow State Memory Binding.
workflowStateMemoryBindingSchema	constant	const workflowStateMemoryBindingSchema: ZodType<WorkflowStateMemoryBinding, ZodTypeDef, WorkflowStateMemoryBinding>	Runtime schema for Workflow State Memory Binding.
validateDomainMemoryDependencySnapshot	function	validateDomainMemoryDependencySnapshot(input: unknown): DomainMemoryDependencySnapshot	Validate Domain Memory Dependency Snapshot function with 1 public call signature; parameters and return types are listed below.
validateMemoryCacheInvalidation	function	validateMemoryCacheInvalidation(input: unknown): MemoryCacheInvalidation	Validate Memory Cache Invalidation function with 1 public call signature; parameters and return types are listed below.
validateMemoryCacheValidityInput	function	validateMemoryCacheValidityInput(input: unknown): MemoryCacheValidityInput	Validate Memory Cache Validity Input function with 1 public call signature; parameters and return types are listed below.
validateMemoryEvaluationCase	function	validateMemoryEvaluationCase(input: unknown): MemoryEvaluationCase	Validate Memory Evaluation Case function with 1 public call signature; parameters and return types are listed below.
validateMemoryEvaluationObservation	function	validateMemoryEvaluationObservation(input: unknown): MemoryEvaluationObservation	Validate Memory Evaluation Observation function with 1 public call signature; parameters and return types are listed below.
validateMemoryReplayReference	function	validateMemoryReplayReference(input: unknown): MemoryReplayReference	Validate Memory Replay Reference function with 1 public call signature; parameters and return types are listed below.
validateSessionMemoryBinding	function	validateSessionMemoryBinding(input: unknown): SessionMemoryBinding	Validate Session Memory Binding function with 1 public call signature; parameters and return types are listed below.
validateWorkflowStateMemoryBinding	function	validateWorkflowStateMemoryBinding(input: unknown): WorkflowStateMemoryBinding	Validate Workflow State Memory Binding function with 1 public call signature; parameters and return types are listed below.

domainMemoryDependencySnapshotSchema

Runtime schema for Domain Memory Dependency Snapshot.

• Kind: constant
• Import: import { domainMemoryDependencySnapshotSchema } from '@codesoul-co/hypha-memory';
• Source module: integration-schema

Declaration

export declare const domainMemoryDependencySnapshotSchema: ZodType<DomainMemoryDependencySnapshot, ZodTypeDef, DomainMemoryDependencySnapshot>;

memoryCacheInvalidationSchema

Runtime schema for Memory Cache Invalidation.

• Kind: constant
• Import: import { memoryCacheInvalidationSchema } from '@codesoul-co/hypha-memory';
• Source module: integration-schema

Declaration

export declare const memoryCacheInvalidationSchema: ZodType<MemoryCacheInvalidation, ZodTypeDef, MemoryCacheInvalidation>;

memoryCacheValidityInputExample

Valid example value for Memory Cache Validity Input.

• Kind: constant
• Import: import { memoryCacheValidityInputExample } from '@codesoul-co/hypha-memory';
• Source module: integration-schema

Declaration

export declare const memoryCacheValidityInputExample: MemoryCacheValidityInput;

memoryCacheValidityInputSchema

Runtime schema for Memory Cache Validity Input.

• Kind: constant
• Import: import { memoryCacheValidityInputSchema } from '@codesoul-co/hypha-memory';
• Source module: integration-schema

Declaration

export declare const memoryCacheValidityInputSchema: ZodType<MemoryCacheValidityInput, ZodTypeDef, MemoryCacheValidityInput>;

memoryEvaluationCaseExample

Valid example value for Memory Evaluation Case.

• Kind: constant
• Import: import { memoryEvaluationCaseExample } from '@codesoul-co/hypha-memory';
• Source module: integration-schema

Declaration

export declare const memoryEvaluationCaseExample: MemoryEvaluationCase;

memoryEvaluationCaseSchema

Runtime schema for Memory Evaluation Case.

• Kind: constant
• Import: import { memoryEvaluationCaseSchema } from '@codesoul-co/hypha-memory';
• Source module: integration-schema

Declaration

export declare const memoryEvaluationCaseSchema: ZodType<MemoryEvaluationCase, ZodTypeDef, MemoryEvaluationCase>;

memoryEvaluationObservationSchema

Runtime schema for Memory Evaluation Observation.

• Kind: constant
• Import: import { memoryEvaluationObservationSchema } from '@codesoul-co/hypha-memory';
• Source module: integration-schema

Declaration

export declare const memoryEvaluationObservationSchema: ZodType<MemoryEvaluationObservation, ZodTypeDef, MemoryEvaluationObservation>;

memoryReplayReferenceExample

Valid example value for Memory Replay Reference.

• Kind: constant
• Import: import { memoryReplayReferenceExample } from '@codesoul-co/hypha-memory';
• Source module: integration-schema

Declaration

export declare const memoryReplayReferenceExample: MemoryReplayReference;

memoryReplayReferenceSchema

Runtime schema for Memory Replay Reference.

• Kind: constant
• Import: import { memoryReplayReferenceSchema } from '@codesoul-co/hypha-memory';
• Source module: integration-schema

Declaration

export declare const memoryReplayReferenceSchema: ZodType<MemoryReplayReference, ZodTypeDef, MemoryReplayReference>;

sessionMemoryBindingExample

Valid example value for Session Memory Binding.

• Kind: constant
• Import: import { sessionMemoryBindingExample } from '@codesoul-co/hypha-memory';
• Source module: integration-schema

Declaration

export declare const sessionMemoryBindingExample: SessionMemoryBinding;

sessionMemoryBindingSchema

Runtime schema for Session Memory Binding.

• Kind: constant
• Import: import { sessionMemoryBindingSchema } from '@codesoul-co/hypha-memory';
• Source module: integration-schema

Declaration

export declare const sessionMemoryBindingSchema: ZodType<SessionMemoryBinding, ZodTypeDef, SessionMemoryBinding>;

workflowStateMemoryBindingExample

Valid example value for Workflow State Memory Binding.

• Kind: constant
• Import: import { workflowStateMemoryBindingExample } from '@codesoul-co/hypha-memory';
• Source module: integration-schema

Declaration

export declare const workflowStateMemoryBindingExample: WorkflowStateMemoryBinding;

workflowStateMemoryBindingSchema

Runtime schema for Workflow State Memory Binding.

• Kind: constant
• Import: import { workflowStateMemoryBindingSchema } from '@codesoul-co/hypha-memory';
• Source module: integration-schema

Declaration

export declare const workflowStateMemoryBindingSchema: ZodType<WorkflowStateMemoryBinding, ZodTypeDef, WorkflowStateMemoryBinding>;

validateDomainMemoryDependencySnapshot

Validate Domain Memory Dependency Snapshot function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateDomainMemoryDependencySnapshot } from '@codesoul-co/hypha-memory';
• Source module: integration-schema

Declaration

export declare function validateDomainMemoryDependencySnapshot(input: unknown): DomainMemoryDependencySnapshot;

Call signature

validateDomainMemoryDependencySnapshot(input: unknown): DomainMemoryDependencySnapshot

Parameters

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

Returns

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

validateMemoryCacheInvalidation

Validate Memory Cache Invalidation function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateMemoryCacheInvalidation } from '@codesoul-co/hypha-memory';
• Source module: integration-schema

Declaration

export declare function validateMemoryCacheInvalidation(input: unknown): MemoryCacheInvalidation;

Call signature

validateMemoryCacheInvalidation(input: unknown): MemoryCacheInvalidation

Parameters

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

Returns

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

validateMemoryCacheValidityInput

Validate Memory Cache Validity Input function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateMemoryCacheValidityInput } from '@codesoul-co/hypha-memory';
• Source module: integration-schema

Declaration

export declare function validateMemoryCacheValidityInput(input: unknown): MemoryCacheValidityInput;

Call signature

validateMemoryCacheValidityInput(input: unknown): MemoryCacheValidityInput

Parameters

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

Returns

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

validateMemoryEvaluationCase

Validate Memory Evaluation Case function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateMemoryEvaluationCase } from '@codesoul-co/hypha-memory';
• Source module: integration-schema

Declaration

export declare function validateMemoryEvaluationCase(input: unknown): MemoryEvaluationCase;

Call signature

validateMemoryEvaluationCase(input: unknown): MemoryEvaluationCase

Parameters

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

Returns

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

validateMemoryEvaluationObservation

Validate Memory Evaluation Observation function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateMemoryEvaluationObservation } from '@codesoul-co/hypha-memory';
• Source module: integration-schema

Declaration

export declare function validateMemoryEvaluationObservation(input: unknown): MemoryEvaluationObservation;

Call signature

validateMemoryEvaluationObservation(input: unknown): MemoryEvaluationObservation

Parameters

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

Returns

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

validateMemoryReplayReference

Validate Memory Replay Reference function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateMemoryReplayReference } from '@codesoul-co/hypha-memory';
• Source module: integration-schema

Declaration

export declare function validateMemoryReplayReference(input: unknown): MemoryReplayReference;

Call signature

validateMemoryReplayReference(input: unknown): MemoryReplayReference

Parameters

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

Returns

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

validateSessionMemoryBinding

Validate Session Memory Binding function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateSessionMemoryBinding } from '@codesoul-co/hypha-memory';
• Source module: integration-schema

Declaration

export declare function validateSessionMemoryBinding(input: unknown): SessionMemoryBinding;

Call signature

validateSessionMemoryBinding(input: unknown): SessionMemoryBinding

Parameters

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

Returns

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

validateWorkflowStateMemoryBinding

Validate Workflow State Memory Binding function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateWorkflowStateMemoryBinding } from '@codesoul-co/hypha-memory';
• Source module: integration-schema

Declaration

export declare function validateWorkflowStateMemoryBinding(input: unknown): WorkflowStateMemoryBinding;

Call signature

validateWorkflowStateMemoryBinding(input: unknown): WorkflowStateMemoryBinding

Parameters

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

Returns

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