@holokai/moku-types

Pure TypeScript type definitions for the Moku API. Zero runtime dependencies.

Installation

npm install @holokai/moku-types

Typically used alongside @holokai/moku-sdk:

import {MokuClient} from '@holokai/moku-sdk';
import type {ApplicationDetail, ThreadDto, PagedResponse} from '@holokai/moku-types';

Type Categories

| Module | Types | |----------------|----------------------------------------------------------------------------| | pagination | PagedResponse<T>, SpringPage<T>, SortObject, PageableObject | | application | ApplicationSummary, ApplicationDetail, create/update requests, filters | | provider | ProviderSummary, ProviderDetail, connectivity test, model sync | | model | ModelSummary, ModelDetail, create/update requests | | organization | OrganizationListItem, OrganizationDetail, BYOK toggle, segments | | team | TeamSummary, TeamDetail, TreeNode hierarchy | | user | UserSummary, UserDetail, role/status updates | | auth | OAuth2ClientRegistration, AuthProviderListItem | | credential | ApiCredentialListItem, ApiCredentialDetail, VaultResponse | | prompt | PromptSummary, PromptDetail, audit entries, references | | project | ProjectDto, ProjectDetailDto, MemberDto | | pricing | Pricing plans, sheets, per-model costs | | plugin | PluginListItem, PluginDetail | | dataset | DatasetListItem, DatasetDetail, samples, references | | evaluation | Plans, sessions, results, analytics, dataset results | | schema | Schema CRUD, versioning, migrations, compatibility validation | | dashboard | Dashboard generation request/response | | analytics | Query execution, widget generation | | monitoring | Request monitoring, RabbitMQ metrics, health status | | server | ServerListItem, ServerDetail, ServerInfo | | audit | AuditEntry, AuditHealthStatus | | thread | ThreadDto, MessageDto, AgentListItem, AgentChatConfig | | refs | SelectItem, RoleOption, RoleHierarchy, SchemaOption | | enums | Status enums, capability types, migration strategies |

Pagination

Two pagination wrappers are provided to match the Java backend:

// Standard pagination (most endpoints)
interface PagedResponse<T> {
    content: T[];
    totalElements: number;
    totalPages: number;
    size: number;
    number: number;
}

// Spring Data page format (schemas, monitoring, audit)
interface SpringPage<T> {
    content: T[];
    totalElements: number;
    totalPages: number;
    size: number;
    number: number;
    pageable: PageableObject;
    sort: SortObject;
}

License

MIT