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

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

Using this module

Use the Context schema module for declaring and runtime-validating contracts. It exports 15 constants, 3 functions.

Import from the package entrypoint

import {
  contextArtifactRefSchema,
  contextBudgetPlanSchema,
  contextBuildRequestSchema,
  contextConflictSchema,
  contextEnvelopeSchema,
  contextItemSchema,
  contextProfileSpecDefinition,
  contextProfileSpecExample,
} from '@codesoul-co/hypha-memory';

// The complete export list is documented below.

Usage patterns

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

Runtime validation example

import { contextArtifactRefSchema } from '@codesoul-co/hypha-memory';

declare function loadExternalInput(): unknown;
const input: unknown = loadExternalInput();
const parsed = contextArtifactRefSchema.parse(input);

Parse untrusted configuration, network, or persisted input with the runtime schema before passing it to functions or classes that expect a validated contract.

Public exports

Symbol	Kind	Signature	Description
contextArtifactRefSchema	constant	const contextArtifactRefSchema: z.ZodObject<{ id: z.ZodString; path: z.ZodString; contentHash: z.ZodString; sizeBytes: z.ZodNumber; contentType: z.ZodLiteral<"text/plain; charset=utf-8">; scopeHash: z.ZodString; profileRevision: z.ZodString; sourceItemId: z.ZodString; createdAt: z.ZodString; expiresAt: z.ZodOptional<z.ZodString>; }, "strict", z.ZodTypeAny, { id: string; path: string; createdAt: string; scopeHash: ...	Runtime schema for Context Artifact Ref.
contextBudgetPlanSchema	constant	const contextBudgetPlanSchema: z.ZodObject<{ totalAvailableTokens: z.ZodNumber; fixedTokens: z.ZodNumber; dynamicTokens: z.ZodNumber; sourceBudgets: z.ZodArray<z.ZodObject<{ sourceId: z.ZodString; minTokens: z.ZodOptional<z.ZodNumber>; targetTokens: z.ZodOptional<z.ZodNumber>; maxTokens: z.ZodNumber; required: z.ZodBoolean; overflowPolicy: z.ZodEnum<["drop", "truncate", "summarize", "spill_to_artifact", "fail"]>; ...	Runtime schema for Context Budget Plan.
contextBuildRequestSchema	constant	const contextBuildRequestSchema: z.ZodType<ContextBuildRequest, z.ZodTypeDef, ContextBuildRequest>	Runtime schema for Context Build Request.
contextConflictSchema	constant	const contextConflictSchema: z.ZodObject<{ conflictGroupId: z.ZodString; itemIds: z.ZodArray<z.ZodString, "many">; resolution: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { conflictGroupId: string; itemIds: string[]; resolution?: string | undefined; }, { conflictGroupId: string; itemIds: string[]; resolution?: string | undefined; }>	Runtime schema for Context Conflict.
contextEnvelopeSchema	constant	const contextEnvelopeSchema: z.ZodType<ContextEnvelope, z.ZodTypeDef, ContextEnvelope>	Runtime schema for Context Envelope.
contextItemSchema	constant	const contextItemSchema: z.ZodEffects<z.ZodObject<{ id: z.ZodString; sourceType: z.ZodEnum<["system", "workflow_state", "messages", "working_memory", "long_term_memory", "tool_observation", "artifact", "human_review", "custom"]>; sourceId: z.ZodOptional<z.ZodString>; content: z.ZodUnknown; text: z.ZodString; tokenEstimate: z.ZodNumber; priority: z.ZodNumber; score: z.ZodOptional<z.ZodNumber>; required: z.ZodOption...	Runtime schema for Context Item.
contextProfileSpecDefinition	constant	const contextProfileSpecDefinition: SpecSchemaDefinition<ContextProfileSpec>	Runtime validation entrypoint for the Context Profile spec, combining its parser, example and JSON Schema.
contextProfileSpecExample	constant	const contextProfileSpecExample: ContextProfileSpec	Valid example value for Context Profile Spec.
contextProfileSpecJsonSchema	constant	const contextProfileSpecJsonSchema: JsonSchema	JSON Schema for Context Profile Spec.
contextProfileSpecSchema	constant	const contextProfileSpecSchema: z.ZodType<ContextProfileSpec, z.ZodTypeDef, ContextProfileSpec>	Runtime schema for Context Profile Spec.
contextProvenanceLabelSchema	constant	const contextProvenanceLabelSchema: z.ZodObject<{ sourceType: z.ZodEnum<["system", "workflow_state", "messages", "working_memory", "long_term_memory", "tool_observation", "artifact", "human_review", "custom"]>; sourceId: z.ZodString; memoryId: z.ZodOptional<z.ZodString>; memoryVersionId: z.ZodOptional<z.ZodString>; authority: z.ZodOptional<z.ZodEnum<["unverified", "user_asserted", "system_observed", "verified", "a...	Runtime schema for Context Provenance Label.
contextSourceBudgetSchema	constant	const contextSourceBudgetSchema: z.ZodObject<{ sourceId: z.ZodString; minTokens: z.ZodOptional<z.ZodNumber>; targetTokens: z.ZodOptional<z.ZodNumber>; maxTokens: z.ZodNumber; required: z.ZodBoolean; overflowPolicy: z.ZodEnum<["drop", "truncate", "summarize", "spill_to_artifact", "fail"]>; }, "strip", z.ZodTypeAny, { required: boolean; sourceId: string; maxTokens: number; overflowPolicy: "summarize" | "fail" | "dro...	Runtime schema for Context Source Budget.
contextSourceSpecSchema	constant	const contextSourceSpecSchema: z.ZodType<ContextSourceSpec, z.ZodTypeDef, ContextSourceSpec>	Runtime schema for Context Source Spec.
contextTruncationRecordSchema	constant	const contextTruncationRecordSchema: z.ZodObject<{ itemId: z.ZodString; originalTokens: z.ZodNumber; retainedTokens: z.ZodNumber; method: z.ZodEnum<["drop", "truncate", "summarize", "spill_to_artifact"]>; reason: z.ZodString; }, "strip", z.ZodTypeAny, { reason: string; itemId: string; originalTokens: number; retainedTokens: number; method: "summarize" | "drop" | "truncate" | "spill_to_artifact"; }, { reason: strin...	Runtime schema for Context Truncation Record.
promptSegmentSchema	constant	const promptSegmentSchema: z.ZodObject<{ id: z.ZodString; role: z.ZodEnum<["system", "developer", "user", "assistant", "tool", "data"]>; text: z.ZodString; tokenCount: z.ZodNumber; trustLevel: z.ZodEnum<["trusted_instruction", "trusted_data", "untrusted_data"]>; sourceRefs: z.ZodArray<z.ZodString, "many">; required: z.ZodOptional<z.ZodBoolean>; artifactRefs: z.ZodOptional<z.ZodArray<z.ZodObject<{ id: z.ZodString; ...	Runtime schema for Prompt Segment.
validateContextEnvelope	function	validateContextEnvelope(input: unknown): ContextEnvelope	Validate Context Envelope function with 1 public call signature; parameters and return types are listed below.
validateContextItem	function	validateContextItem(input: unknown): ContextItem	Validate Context Item function with 1 public call signature; parameters and return types are listed below.
validateContextProfileSpec	function	validateContextProfileSpec(input: unknown): ContextProfileSpec	Validate Context Profile Spec function with 1 public call signature; parameters and return types are listed below.

contextArtifactRefSchema

Runtime schema for Context Artifact Ref.

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

Declaration

export declare const contextArtifactRefSchema: z.ZodObject<{ id: z.ZodString; path: z.ZodString; contentHash: z.ZodString; sizeBytes: z.ZodNumber; contentType: z.ZodLiteral<"text/plain; charset=utf-8">; scopeHash: z.ZodString; profileRevision: z.ZodString; sourceItemId: z.ZodString; createdAt: z.ZodString; expiresAt: z.ZodOptional<z.ZodString>; }, "strict", z.ZodTypeAny, { id: string; path: string; createdAt: string; scopeHash: string; contentType: "text/plain; charset=utf-8"; sizeBytes: number; profileRevision: string; sourceItemId: string; contentHash: string; expiresAt?: string | undefined; }, { id: string; path: string; createdAt: string; scopeHash: string; contentType: "text/plain; charset=utf-8"; sizeBytes: number; profileRevision: string; sourceItemId: string; contentHash: string; expiresAt?: string | undefined; }>;

contextBudgetPlanSchema

Runtime schema for Context Budget Plan.

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

Declaration

export declare const contextBudgetPlanSchema: z.ZodObject<{ totalAvailableTokens: z.ZodNumber; fixedTokens: z.ZodNumber; dynamicTokens: z.ZodNumber; sourceBudgets: z.ZodArray<z.ZodObject<{ sourceId: z.ZodString; minTokens: z.ZodOptional<z.ZodNumber>; targetTokens: z.ZodOptional<z.ZodNumber>; maxTokens: z.ZodNumber; required: z.ZodBoolean; overflowPolicy: z.ZodEnum<["drop", "truncate", "summarize", "spill_to_artifact", "fail"]>; }, "strip", z.ZodTypeAny, { required: boolean; sourceId: string; maxTokens: number; overflowPolicy: "summarize" | "fail" | "drop" | "truncate" | "spill_to_artifact"; minTokens?: number | undefined; targetTokens?: number | undefined; }, { required: boolean; sourceId: string; maxTokens: number; overflowPolicy: "summarize" | "fail" | "drop" | "truncate" | "spill_to_artifact"; minTokens?: number | undefined; targetTokens?: number | undefined; }>, "many">; tokenizerRef: z.ZodObject<{ id: z.ZodString; version: z.ZodOptional<z.ZodString>; } & { revision: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { id: string; version?: string | undefined; revision?: string | undefined; }, { id: string; version?: string | undefined; revision?: string | undefined; }>; safetyMarginTokens: z.ZodNumber; }, "strip", z.ZodTypeAny, { totalAvailableTokens: number; fixedTokens: number; dynamicTokens: number; sourceBudgets: { required: boolean; sourceId: string; maxTokens: number; overflowPolicy: "summarize" | "fail" | "drop" | "truncate" | "spill_to_artifact"; minTokens?: number | undefined; targetTokens?: number | undefined; }[]; tokenizerRef: { id: string; version?: string | undefined; revision?: string | undefined; }; safetyMarginTokens: number; }, { totalAvailableTokens: number; fixedTokens: number; dynamicTokens: number; sourceBudgets: { required: boolean; sourceId: string; maxTokens: number; overflowPolicy: "summarize" | "fail" | "drop" | "truncate" | "spill_to_artifact"; minTokens?: number | undefined; targetTokens?: number | undefined; }[]; tokenizerRef: { id: string; version?: string | undefined; revision?: string | undefined; }; safetyMarginTokens: number; }>;

contextBuildRequestSchema

Runtime schema for Context Build Request.

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

Declaration

export declare const contextBuildRequestSchema: z.ZodType<ContextBuildRequest, z.ZodTypeDef, ContextBuildRequest>;

contextConflictSchema

Runtime schema for Context Conflict.

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

Declaration

export declare const contextConflictSchema: z.ZodObject<{ conflictGroupId: z.ZodString; itemIds: z.ZodArray<z.ZodString, "many">; resolution: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { conflictGroupId: string; itemIds: string[]; resolution?: string | undefined; }, { conflictGroupId: string; itemIds: string[]; resolution?: string | undefined; }>;

contextEnvelopeSchema

Runtime schema for Context Envelope.

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

Declaration

export declare const contextEnvelopeSchema: z.ZodType<ContextEnvelope, z.ZodTypeDef, ContextEnvelope>;

contextItemSchema

Runtime schema for Context Item.

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

Declaration

// Exact type resolved from the package entrypoint; see source for the compiler expansion.
export declare const contextItemSchema: (typeof import('@codesoul-co/hypha-memory'))['contextItemSchema'];

This compiler-expanded constant type is compacted. Its public name, top-level type, and source location remain here; use the module’s exported interfaces, types, or runtime schema for input/output fields.

contextProfileSpecDefinition

Runtime validation entrypoint for the Context Profile spec, combining its parser, example and JSON Schema.

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

Declaration

export declare const contextProfileSpecDefinition: SpecSchemaDefinition<ContextProfileSpec>;

contextProfileSpecExample

Valid example value for Context Profile Spec.

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

Declaration

export declare const contextProfileSpecExample: ContextProfileSpec;

contextProfileSpecJsonSchema

JSON Schema for Context Profile Spec.

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

Declaration

export declare const contextProfileSpecJsonSchema: JsonSchema;

contextProfileSpecSchema

Runtime schema for Context Profile Spec.

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

Declaration

export declare const contextProfileSpecSchema: z.ZodType<ContextProfileSpec, z.ZodTypeDef, ContextProfileSpec>;

contextProvenanceLabelSchema

Runtime schema for Context Provenance Label.

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

Declaration

export declare const contextProvenanceLabelSchema: z.ZodObject<{ sourceType: z.ZodEnum<["system", "workflow_state", "messages", "working_memory", "long_term_memory", "tool_observation", "artifact", "human_review", "custom"]>; sourceId: z.ZodString; memoryId: z.ZodOptional<z.ZodString>; memoryVersionId: z.ZodOptional<z.ZodString>; authority: z.ZodOptional<z.ZodEnum<["unverified", "user_asserted", "system_observed", "verified", "authoritative"]>>; observedAt: z.ZodOptional<z.ZodString>; citationLabel: z.ZodString; }, "strip", z.ZodTypeAny, { sourceType: "artifact" | "custom" | "human_review" | "tool_observation" | "workflow_state" | "system" | "messages" | "working_memory" | "long_term_memory"; sourceId: string; citationLabel: string; memoryId?: string | undefined; memoryVersionId?: string | undefined; authority?: "unverified" | "user_asserted" | "system_observed" | "verified" | "authoritative" | undefined; observedAt?: string | undefined; }, { sourceType: "artifact" | "custom" | "human_review" | "tool_observation" | "workflow_state" | "system" | "messages" | "working_memory" | "long_term_memory"; sourceId: string; citationLabel: string; memoryId?: string | undefined; memoryVersionId?: string | undefined; authority?: "unverified" | "user_asserted" | "system_observed" | "verified" | "authoritative" | undefined; observedAt?: string | undefined; }>;

contextSourceBudgetSchema

Runtime schema for Context Source Budget.

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

Declaration

export declare const contextSourceBudgetSchema: z.ZodObject<{ sourceId: z.ZodString; minTokens: z.ZodOptional<z.ZodNumber>; targetTokens: z.ZodOptional<z.ZodNumber>; maxTokens: z.ZodNumber; required: z.ZodBoolean; overflowPolicy: z.ZodEnum<["drop", "truncate", "summarize", "spill_to_artifact", "fail"]>; }, "strip", z.ZodTypeAny, { required: boolean; sourceId: string; maxTokens: number; overflowPolicy: "summarize" | "fail" | "drop" | "truncate" | "spill_to_artifact"; minTokens?: number | undefined; targetTokens?: number | undefined; }, { required: boolean; sourceId: string; maxTokens: number; overflowPolicy: "summarize" | "fail" | "drop" | "truncate" | "spill_to_artifact"; minTokens?: number | undefined; targetTokens?: number | undefined; }>;

contextSourceSpecSchema

Runtime schema for Context Source Spec.

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

Declaration

export declare const contextSourceSpecSchema: z.ZodType<ContextSourceSpec, z.ZodTypeDef, ContextSourceSpec>;

contextTruncationRecordSchema

Runtime schema for Context Truncation Record.

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

Declaration

export declare const contextTruncationRecordSchema: z.ZodObject<{ itemId: z.ZodString; originalTokens: z.ZodNumber; retainedTokens: z.ZodNumber; method: z.ZodEnum<["drop", "truncate", "summarize", "spill_to_artifact"]>; reason: z.ZodString; }, "strip", z.ZodTypeAny, { reason: string; itemId: string; originalTokens: number; retainedTokens: number; method: "summarize" | "drop" | "truncate" | "spill_to_artifact"; }, { reason: string; itemId: string; originalTokens: number; retainedTokens: number; method: "summarize" | "drop" | "truncate" | "spill_to_artifact"; }>;

promptSegmentSchema

Runtime schema for Prompt Segment.

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

Declaration

export declare const promptSegmentSchema: z.ZodObject<{ id: z.ZodString; role: z.ZodEnum<["system", "developer", "user", "assistant", "tool", "data"]>; text: z.ZodString; tokenCount: z.ZodNumber; trustLevel: z.ZodEnum<["trusted_instruction", "trusted_data", "untrusted_data"]>; sourceRefs: z.ZodArray<z.ZodString, "many">; required: z.ZodOptional<z.ZodBoolean>; artifactRefs: z.ZodOptional<z.ZodArray<z.ZodObject<{ id: z.ZodString; path: z.ZodString; contentHash: z.ZodString; sizeBytes: z.ZodNumber; contentType: z.ZodLiteral<"text/plain; charset=utf-8">; scopeHash: z.ZodString; profileRevision: z.ZodString; sourceItemId: z.ZodString; createdAt: z.ZodString; expiresAt: z.ZodOptional<z.ZodString>; }, "strict", z.ZodTypeAny, { id: string; path: string; createdAt: string; scopeHash: string; contentType: "text/plain; charset=utf-8"; sizeBytes: number; profileRevision: string; sourceItemId: string; contentHash: string; expiresAt?: string | undefined; }, { id: string; path: string; createdAt: string; scopeHash: string; contentType: "text/plain; charset=utf-8"; sizeBytes: number; profileRevision: string; sourceItemId: string; contentHash: string; expiresAt?: string | undefined; }>, "many">>; }, "strip", z.ZodTypeAny, { id: string; text: string; role: "tool" | "system" | "developer" | "user" | "assistant" | "data"; tokenCount: number; trustLevel: "trusted_instruction" | "trusted_data" | "untrusted_data"; sourceRefs: string[]; required?: boolean | undefined; artifactRefs?: { id: string; path: string; createdAt: string; scopeHash: string; contentType: "text/plain; charset=utf-8"; sizeBytes: number; profileRevision: string; sourceItemId: string; contentHash: string; expiresAt?: string | undefined; }[] | undefined; }, { id: string; text: string; role: "tool" | "system" | "developer" | "user" | "assistant" | "data"; tokenCount: number; trustLevel: "trusted_instruction" | "trusted_data" | "untrusted_data"; sourceRefs: string[]; required?: boolean | undefined; artifactRefs?: { id: string; path: string; createdAt: string; scopeHash: string; contentType: "text/plain; charset=utf-8"; sizeBytes: number; profileRevision: string; sourceItemId: string; contentHash: string; expiresAt?: string | undefined; }[] | undefined; }>;

validateContextEnvelope

Validate Context Envelope function with 1 public call signature; parameters and return types are listed below.

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

Declaration

export declare function validateContextEnvelope(input: unknown): ContextEnvelope;

Call signature

validateContextEnvelope(input: unknown): ContextEnvelope

Parameters

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

Returns

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

validateContextItem

Validate Context Item function with 1 public call signature; parameters and return types are listed below.

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

Declaration

export declare function validateContextItem(input: unknown): ContextItem;

Call signature

validateContextItem(input: unknown): ContextItem

Parameters

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

Returns

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

validateContextProfileSpec

Validate Context Profile Spec function with 1 public call signature; parameters and return types are listed below.

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

Declaration

export declare function validateContextProfileSpec(input: unknown): ContextProfileSpec;

Call signature

validateContextProfileSpec(input: unknown): ContextProfileSpec

Parameters

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

Returns

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