TypeScript SDK

Install (canonical name; this GitLab project, not the public npm index):

npm config set @eve-iac:registry https://gitlab.com/api/v4/projects/eve-ng-dev%2Feve-iac/packages/npm/
npm install @eve-iac/sdk

Or install the tarball from a GitLab Release / out/npm/ (make pack-sdk). Details: Install packages.

Imports

import {
  createEveIacClient,
  AgentError,
  isAuthError,
  type LoginRequest,
  type PlanProjectRequest,
} from "@eve-iac/sdk";

createEveIacClient builds EveIacClient with the Node HTTPS transport. Generated types and EveIacClient methods are re-exported.

Create a client

import { createEveIacClient } from "@eve-iac/sdk";

const client = createEveIacClient({
  url: "https://eve.example:8787",
  token: "",
  caPem,
  timeoutMs: 15000,
});

TransportConfig: url, token, optional caPem, optional timeoutMs. HTTPS is required.

Omission

  • undefined is omitted
  • null remains explicit null where supported
  • false / 0 / "" remain explicit values

Many operation methods take ProjectPayload (see planProject) even though aliases such as PlanProjectRequest exist.

Responses

Methods return typed objects. Failures reject with AgentError. CLI --json prints the same wire shape.

Documentation map

Page Hand-written (site/pages/…) Generated (sdk/generated/site/…)
Getting started developers/typescript/index.md —
Authentication developers/typescript/authentication.md —
How-to, Examples, API, Models — developers/typescript/howto.md, examples.md, api.md, models.md

Relative links below work on the built site. In Git, open sdk/generated/site/developers/typescript/. Run make sdk-generate after spec or generator changes.

Next