@codesoul-co/hypha-core / ids

• Package index: @codesoul-co/hypha-core
• Source: packages/core/src/ids.ts
• Exports: 3

Using this module

Use the Ids module for using the public contracts and operations for this capability boundary. It exports 1 function, 1 interface, 1 type.

Import from the package entrypoint

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

import type {
  FrameworkId,
  FrameworkIdPrefix,
} from '@codesoul-co/hypha-core';

Usage patterns

• Use the 2 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 function as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.

Public exports

Symbol	Kind	Signature	Description
formatFrameworkId	function	formatFrameworkId(id: FrameworkId): string	Format Framework ID function with 1 public call signature; parameters and return types are listed below.
FrameworkId	interface	interface FrameworkId	Framework ID interface with 2 public fields or methods.
FrameworkIdPrefix	type	type FrameworkIdPrefix = 'workspace' | 'session' | 'run' | 'step' | 'event' | 'agent' | 'skill' | 'tool' | 'memory' | 'model' | 'domain' | 'workflow' | 'policy' | 'artifact'	Public type alias for Framework ID Prefix; the declaration contains its complete type expression.

formatFrameworkId

Format Framework ID function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { formatFrameworkId } from '@codesoul-co/hypha-core';
• Source module: ids

Declaration

export declare function formatFrameworkId(id: FrameworkId): string;

Call signature

formatFrameworkId(id: FrameworkId): string

Parameters

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

Returns

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

FrameworkId

Framework ID interface with 2 public fields or methods.

• Kind: interface
• Import: import type { FrameworkId } from '@codesoul-co/hypha-core';
• Source module: ids

Declaration

export interface FrameworkId {
    prefix: FrameworkIdPrefix;
    value: string;
}

Contract members

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

FrameworkIdPrefix

Public type alias for Framework ID Prefix; the declaration contains its complete type expression.

• Kind: type
• Import: import type { FrameworkIdPrefix } from '@codesoul-co/hypha-core';
• Source module: ids

Declaration

export type FrameworkIdPrefix = 'workspace' | 'session' | 'run' | 'step' | 'event' | 'agent' | 'skill' | 'tool' | 'memory' | 'model' | 'domain' | 'workflow' | 'policy' | 'artifact';