@codesoul-co/hypha-core / modules/runtime/session-command-payload-store

• Package index: @codesoul-co/hypha-core
• Source: packages/core/src/modules/runtime/session-command-payload-store.ts
• Exports: 5

Using this module

Use the Session command payload store module for persisting and reading data at this boundary. It exports 1 class, 3 interfaces, 1 type.

Import from the package entrypoint

import {
  ArtifactSessionCommandPayloadStore,
} from '@codesoul-co/hypha-core';

import type {
  ArtifactSessionCommandPayloadStoreOptions,
  PutSessionCommandPayloadRequest,
  SessionCommandPayloadReference,
  GetSessionCommandPayloadRequest,
} from '@codesoul-co/hypha-core';

Usage patterns

• Use the 4 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 1 class as constructable runtime implementations. Each symbol entry lists its constructor and public methods.

Public exports

Symbol	Kind	Signature	Description
ArtifactSessionCommandPayloadStore	class	new ArtifactSessionCommandPayloadStore(options: ArtifactSessionCommandPayloadStoreOptions): ArtifactSessionCommandPayloadStore	Stores canonical command JSON outside the Queue while retaining a verified durable reference.
ArtifactSessionCommandPayloadStoreOptions	interface	interface ArtifactSessionCommandPayloadStoreOptions	Artifact Session Command Payload Store Options interface with 2 public fields or methods.
PutSessionCommandPayloadRequest	interface	interface PutSessionCommandPayloadRequest	Put Session Command Payload Request interface with 2 public fields or methods.
SessionCommandPayloadReference	interface	interface SessionCommandPayloadReference	Session Command Payload Reference interface with 2 public fields or methods.
GetSessionCommandPayloadRequest	type	type GetSessionCommandPayloadRequest = SessionCommandPayloadReference	Public type alias for Get Session Command Payload Request; the declaration contains its complete type expression.

ArtifactSessionCommandPayloadStore

Stores canonical command JSON outside the Queue while retaining a verified durable reference.

• Kind: class
• Import: import { ArtifactSessionCommandPayloadStore } from '@codesoul-co/hypha-core';
• Source module: modules/runtime/session-command-payload-store

Declaration

export declare class ArtifactSessionCommandPayloadStore {
    constructor(options: ArtifactSessionCommandPayloadStoreOptions);
    put(request: PutSessionCommandPayloadRequest): Promise<SessionCommandPayloadReference>;
    get(request: GetSessionCommandPayloadRequest): Promise<unknown>;
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(options: ArtifactSessionCommandPayloadStoreOptions): ArtifactSessionCommandPayloadStore	Creates an instance of this class.
get	method	get(request: GetSessionCommandPayloadRequest): Promise<unknown>	Public method; parameters and return type are shown in the signature.
put	method	put(request: PutSessionCommandPayloadRequest): Promise<SessionCommandPayloadReference>	Public method; parameters and return type are shown in the signature.

ArtifactSessionCommandPayloadStoreOptions

Artifact Session Command Payload Store Options interface with 2 public fields or methods.

• Kind: interface
• Import: import type { ArtifactSessionCommandPayloadStoreOptions } from '@codesoul-co/hypha-core';
• Source module: modules/runtime/session-command-payload-store

Declaration

export interface ArtifactSessionCommandPayloadStoreOptions {
    artifacts: ArtifactStoreProvider;
    maxPayloadBytes?: number;
}

Contract members

Member	Kind	Signature	Description
artifacts	property	artifacts: ArtifactStoreProvider	Public property; its type, readonly modifier and optionality are shown in the signature.
maxPayloadBytes	property	maxPayloadBytes?: number	Public property; its type, readonly modifier and optionality are shown in the signature.

PutSessionCommandPayloadRequest

Put Session Command Payload Request interface with 2 public fields or methods.

• Kind: interface
• Import: import type { PutSessionCommandPayloadRequest } from '@codesoul-co/hypha-core';
• Source module: modules/runtime/session-command-payload-store

Declaration

export interface PutSessionCommandPayloadRequest {
    commandId: string;
    payload: unknown;
}

Contract members

Member	Kind	Signature	Description
commandId	property	commandId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
payload	property	payload: unknown	Public property; its type, readonly modifier and optionality are shown in the signature.

SessionCommandPayloadReference

Session Command Payload Reference interface with 2 public fields or methods.

• Kind: interface
• Import: import type { SessionCommandPayloadReference } from '@codesoul-co/hypha-core';
• Source module: modules/runtime/session-command-payload-store

Declaration

export interface SessionCommandPayloadReference {
    payloadRef: string;
    payloadHash: string;
}

Contract members

Member	Kind	Signature	Description
payloadHash	property	payloadHash: string	Public property; its type, readonly modifier and optionality are shown in the signature.
payloadRef	property	payloadRef: string	Public property; its type, readonly modifier and optionality are shown in the signature.

GetSessionCommandPayloadRequest

Public type alias for Get Session Command Payload Request; the declaration contains its complete type expression.

• Kind: type
• Import: import type { GetSessionCommandPayloadRequest } from '@codesoul-co/hypha-core';
• Source module: modules/runtime/session-command-payload-store

Declaration

export type GetSessionCommandPayloadRequest = SessionCommandPayloadReference;