Skip to content

@privateaim/core-kit

Domain models, types, and error definitions for the PrivateAIM core service. Defines all entity types used by server-core and consumed by clients.

Installation

bash
npm install @privateaim/core-kit

Usage

Domain Types

typescript
import {
    Analysis,
    AnalysisRunStatus,
    Node,
    Project,
    Registry,
    MasterImage,
} from '@privateaim/core-kit';

Validators

typescript
import { analysisSchema } from '@privateaim/core-kit';

const result = analysisSchema.safeParse(data);

Error Handling

typescript
import { CoreError } from '@privateaim/core-kit';

API

Exports

ModuleDescription
domainsEntity types: Analysis, Node, Project, Registry, MasterImage, etc.
errorCore-specific error types
constantsDomain constants and enums (statuses, permission names)

Key Domain Types

TypeDescription
AnalysisDistributed computation task
AnalysisBucketFile storage container for an analysis
ProjectUser project grouping nodes and analyses
ProjectNodeNode assigned to a project
NodeCompute node in the network
MasterImageBase Docker image for worker tasks
RegistryDocker registry configuration
RegistryProjectProject within a Docker registry

Dependencies

  • @privateaim/kit — Core utilities
  • @authup/core-kit — Authup types
  • @privateaim/telemetry-kit — Telemetry types

Released under the Apache-2.0 License.