@codesoul-co/hypha-memory / operation-contract

• Package index: @codesoul-co/hypha-memory
• Source: packages/memory/src/operation-contract.ts
• Exports: 12

Using this module

Use the Operation contract module for declaring and runtime-validating contracts. It exports 8 constants, 4 functions.

Import from the package entrypoint

import {
  managedMemoryDeleteRequestSchema,
  managedMemorySearchRequestSchema,
  managedMemoryUpdateRequestSchema,
  memoryAddRequestExample,
  memoryAddRequestSchema,
  memoryPatchSchema,
  memorySearchFilterSchema,
  paginationRequestSchema,
} from '@codesoul-co/hypha-memory';

// The complete export list is documented below.

Usage patterns

• The module exposes 4 functions as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.
• The 8 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 { managedMemoryDeleteRequestSchema } from '@codesoul-co/hypha-memory';

declare function loadExternalInput(): unknown;
const input: unknown = loadExternalInput();
const parsed = managedMemoryDeleteRequestSchema.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
managedMemoryDeleteRequestSchema	constant	const managedMemoryDeleteRequestSchema: z.ZodType<ManagedMemoryDeleteRequest, z.ZodTypeDef, ManagedMemoryDeleteRequest>	Runtime schema for Managed Memory Delete Request.
managedMemorySearchRequestSchema	constant	const managedMemorySearchRequestSchema: z.ZodType<ManagedMemorySearchRequest, z.ZodTypeDef, ManagedMemorySearchRequest>	Runtime schema for Managed Memory Search Request.
managedMemoryUpdateRequestSchema	constant	const managedMemoryUpdateRequestSchema: z.ZodType<ManagedMemoryUpdateRequest, z.ZodTypeDef, ManagedMemoryUpdateRequest>	Runtime schema for Managed Memory Update Request.
memoryAddRequestExample	constant	const memoryAddRequestExample: MemoryAddRequest	Valid example value for Memory Add Request.
memoryAddRequestSchema	constant	const memoryAddRequestSchema: z.ZodEffects<z.ZodObject<{ operationId: z.ZodString; principal: z.ZodObject<{ principalId: z.ZodString; type: z.ZodEnum<["user", "agent", "service", "system"]>; tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodOptional<z.ZodString>; agentId: z.ZodOptional<z.ZodString>; roles: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; permissionScopes: z.ZodArray<z.ZodString, "many">; metadata:...	Runtime schema for Memory Add Request.
memoryPatchSchema	constant	const memoryPatchSchema: z.ZodEffects<z.ZodObject<{ content: z.ZodOptional<z.ZodUnknown>; canonicalText: z.ZodOptional<z.ZodString>; summary: z.ZodOptional<z.ZodString>; confidence: z.ZodOptional<z.ZodNumber>; importance: z.ZodOptional<z.ZodNumber>; tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; status: z.ZodOptional<z.ZodEnum<["pending", "active", "dormant", "superseded", "invalidated", "deletion_pending",...	Runtime schema for Memory Patch.
memorySearchFilterSchema	constant	const memorySearchFilterSchema: z.ZodType<MemorySearchFilter, z.ZodTypeDef, MemorySearchFilter>	Runtime schema for Memory Search Filter.
paginationRequestSchema	constant	const paginationRequestSchema: z.ZodType<PaginationRequest, z.ZodTypeDef, PaginationRequest>	Runtime schema for Pagination Request.
validateManagedMemoryDeleteRequest	function	validateManagedMemoryDeleteRequest(input: unknown): ManagedMemoryDeleteRequest	Validate Managed Memory Delete Request function with 1 public call signature; parameters and return types are listed below.
validateManagedMemorySearchRequest	function	validateManagedMemorySearchRequest(input: unknown): ManagedMemorySearchRequest	Validate Managed Memory Search Request function with 1 public call signature; parameters and return types are listed below.
validateManagedMemoryUpdateRequest	function	validateManagedMemoryUpdateRequest(input: unknown): ManagedMemoryUpdateRequest	Validate Managed Memory Update Request function with 1 public call signature; parameters and return types are listed below.
validateMemoryAddRequest	function	validateMemoryAddRequest(input: unknown): MemoryAddRequest	Validate Memory Add Request function with 1 public call signature; parameters and return types are listed below.

managedMemoryDeleteRequestSchema

Runtime schema for Managed Memory Delete Request.

• Kind: constant
• Import: import { managedMemoryDeleteRequestSchema } from '@codesoul-co/hypha-memory';
• Source module: operation-contract

Declaration

export declare const managedMemoryDeleteRequestSchema: z.ZodType<ManagedMemoryDeleteRequest, z.ZodTypeDef, ManagedMemoryDeleteRequest>;

managedMemorySearchRequestSchema

Runtime schema for Managed Memory Search Request.

• Kind: constant
• Import: import { managedMemorySearchRequestSchema } from '@codesoul-co/hypha-memory';
• Source module: operation-contract

Declaration

export declare const managedMemorySearchRequestSchema: z.ZodType<ManagedMemorySearchRequest, z.ZodTypeDef, ManagedMemorySearchRequest>;

managedMemoryUpdateRequestSchema

Runtime schema for Managed Memory Update Request.

• Kind: constant
• Import: import { managedMemoryUpdateRequestSchema } from '@codesoul-co/hypha-memory';
• Source module: operation-contract

Declaration

export declare const managedMemoryUpdateRequestSchema: z.ZodType<ManagedMemoryUpdateRequest, z.ZodTypeDef, ManagedMemoryUpdateRequest>;

memoryAddRequestExample

Valid example value for Memory Add Request.

• Kind: constant
• Import: import { memoryAddRequestExample } from '@codesoul-co/hypha-memory';
• Source module: operation-contract

Declaration

export declare const memoryAddRequestExample: MemoryAddRequest;

memoryAddRequestSchema

Runtime schema for Memory Add Request.

• Kind: constant
• Import: import { memoryAddRequestSchema } from '@codesoul-co/hypha-memory';
• Source module: operation-contract

Declaration

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

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.

memoryPatchSchema

Runtime schema for Memory Patch.

• Kind: constant
• Import: import { memoryPatchSchema } from '@codesoul-co/hypha-memory';
• Source module: operation-contract

Declaration

export declare const memoryPatchSchema: z.ZodEffects<z.ZodObject<{ content: z.ZodOptional<z.ZodUnknown>; canonicalText: z.ZodOptional<z.ZodString>; summary: z.ZodOptional<z.ZodString>; confidence: z.ZodOptional<z.ZodNumber>; importance: z.ZodOptional<z.ZodNumber>; tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; status: z.ZodOptional<z.ZodEnum<["pending", "active", "dormant", "superseded", "invalidated", "deletion_pending", "failed"]>>; metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>; }, "strip", z.ZodTypeAny, { status?: "pending" | "failed" | "active" | "dormant" | "superseded" | "invalidated" | "deletion_pending" | undefined; tags?: string[] | undefined; metadata?: Record<string, unknown> | undefined; confidence?: number | undefined; canonicalText?: string | undefined; content?: unknown; importance?: number | undefined; summary?: string | undefined; }, { status?: "pending" | "failed" | "active" | "dormant" | "superseded" | "invalidated" | "deletion_pending" | undefined; tags?: string[] | undefined; metadata?: Record<string, unknown> | undefined; confidence?: number | undefined; canonicalText?: string | undefined; content?: unknown; importance?: number | undefined; summary?: string | undefined; }>, { status?: "pending" | "failed" | "active" | "dormant" | "superseded" | "invalidated" | "deletion_pending" | undefined; tags?: string[] | undefined; metadata?: Record<string, unknown> | undefined; confidence?: number | undefined; canonicalText?: string | undefined; content?: unknown; importance?: number | undefined; summary?: string | undefined; }, { status?: "pending" | "failed" | "active" | "dormant" | "superseded" | "invalidated" | "deletion_pending" | undefined; tags?: string[] | undefined; metadata?: Record<string, unknown> | undefined; confidence?: number | undefined; canonicalText?: string | undefined; content?: unknown; importance?: number | undefined; summary?: string | undefined; }>;

memorySearchFilterSchema

Runtime schema for Memory Search Filter.

• Kind: constant
• Import: import { memorySearchFilterSchema } from '@codesoul-co/hypha-memory';
• Source module: operation-contract

Declaration

export declare const memorySearchFilterSchema: z.ZodType<MemorySearchFilter, z.ZodTypeDef, MemorySearchFilter>;

paginationRequestSchema

Runtime schema for Pagination Request.

• Kind: constant
• Import: import { paginationRequestSchema } from '@codesoul-co/hypha-memory';
• Source module: operation-contract

Declaration

export declare const paginationRequestSchema: z.ZodType<PaginationRequest, z.ZodTypeDef, PaginationRequest>;

validateManagedMemoryDeleteRequest

Validate Managed Memory Delete Request function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateManagedMemoryDeleteRequest } from '@codesoul-co/hypha-memory';
• Source module: operation-contract

Declaration

export declare function validateManagedMemoryDeleteRequest(input: unknown): ManagedMemoryDeleteRequest;

Call signature

validateManagedMemoryDeleteRequest(input: unknown): ManagedMemoryDeleteRequest

Parameters

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

Returns

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

validateManagedMemorySearchRequest

Validate Managed Memory Search Request function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateManagedMemorySearchRequest } from '@codesoul-co/hypha-memory';
• Source module: operation-contract

Declaration

export declare function validateManagedMemorySearchRequest(input: unknown): ManagedMemorySearchRequest;

Call signature

validateManagedMemorySearchRequest(input: unknown): ManagedMemorySearchRequest

Parameters

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

Returns

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

validateManagedMemoryUpdateRequest

Validate Managed Memory Update Request function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateManagedMemoryUpdateRequest } from '@codesoul-co/hypha-memory';
• Source module: operation-contract

Declaration

export declare function validateManagedMemoryUpdateRequest(input: unknown): ManagedMemoryUpdateRequest;

Call signature

validateManagedMemoryUpdateRequest(input: unknown): ManagedMemoryUpdateRequest

Parameters

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

Returns

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

validateMemoryAddRequest

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

• Kind: function
• Import: import { validateMemoryAddRequest } from '@codesoul-co/hypha-memory';
• Source module: operation-contract

Declaration

export declare function validateMemoryAddRequest(input: unknown): MemoryAddRequest;

Call signature

validateMemoryAddRequest(input: unknown): MemoryAddRequest

Parameters

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

Returns

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