@ni/systemlink-clients-ts

Auto-generated TypeScript API clients for all NI SystemLink services, generated from their official OpenAPI specifications.

• 27 services with full TypeScript types, SDK functions, and tree-shakeable ESM/CJS builds
• Fetch-based — uses the browser fetch API; works in Angular, React, Node.js, and any modern runtime
• No runtime dependencies — the fetch client is bundled inline

Installation

npm install @ni/systemlink-clients-ts

Quick start (Angular)

Each service has two sub-paths:

| Import path | What you get | | -------------------------------------------- | --------------------------------------------------------------- | | @ni/systemlink-clients-ts/<service> | SDK functions + all TypeScript types | | @ni/systemlink-clients-ts/<service>/client | createClient, createConfig, and the default client instance |

Inject a configured client in an Angular service

// src/app/core/alarm.service.ts
import { Injectable } from "@angular/core";
import { environment } from "../../environments/environment";

import {
  createClient,
  createConfig,
} from "@ni/systemlink-clients-ts/alarm/client";
import {
  postNialarmV1QueryInstances,
  type QueryRequest,
  type QueryResponse,
} from "@ni/systemlink-clients-ts/alarm";

@Injectable({ providedIn: "root" })
export class AlarmService {
  private readonly client = createClient(
    createConfig({
      baseUrl: environment.systemlinkBaseUrl,
      headers: { "x-ni-api-key": environment.apiKey },
    }),
  );

  async queryAlarms(filter?: string): Promise<QueryResponse | undefined> {
    const body: QueryRequest = { filter };
    const { data } = await postNialarmV1QueryInstances({
      client: this.client,
      body,
    });
    return data;
  }
}

Angular environment.ts example

// src/environments/environment.ts
export const environment = {
  production: false,
  systemlinkBaseUrl: "https://your-systemlink-server.example.com",
  apiKey: "your-x-ni-api-key",
};

Note: systemlinkBaseUrl above is the bare server origin and works for services whose generated operation URLs already include the service prefix (e.g. alarm, feeds, asset-management). Services such as tags, test-monitor, and user require a service-specific prefix in baseUrl. See Services with path-prefixed base URLs for the full list.

Available services

| Sub-path | Description | | ----------------------------- | --------------------------------------------- | | alarm | Alarm management (instances, acknowledgement) | | asset-management | Assets, calibration history, asset summary | | auth | Authentication and authorization tokens | | comments | Comments on SystemLink resources | | dataframe | DataFrame table service | | dynamic-form-fields | Custom fields and schema management | | feeds | Package feed management | | file-ingestion | File upload and ingestion | | location | Location hierarchy and geospatial | | notebook | Jupyter notebook management | | notebook-execution | Notebook execution jobs | | notebook-execution-artifact | Execution output artifacts | | notification | Notifications and subscriptions | | repository | Package repository (NI Package Manager) | | routines | Scheduled and event-driven routines | | routines-v2 | Routines API v2 | | specification-management | Test specification management | | systems-management | Managed systems fleet | | systems-state | System state and health | | tag-historian | Historical tag values | | tags | Tag reads and writes | | test-monitor | Test results, steps, products | | user | Users, workspaces, and access | | user-data | User-defined structured data | | web-application | Web application registry | | work-item | Work items (tasks, defects) | | work-order | Work orders |

Client configuration patterns

One shared client per Angular module

import {
  createClient,
  createConfig,
} from "@ni/systemlink-clients-ts/test-monitor/client";

// Create once, inject everywhere
export const testMonitorClient = createClient(
  createConfig({
    baseUrl: "https://your-server.example.com/nitestmonitor",
    headers: { "x-ni-api-key": "your-key" },
  }),
);

Note on base URLs: The correct baseUrl depends on whether the generated operation URLs for that service already include the service prefix.

• If the operation URL starts with /v1, /v2, /users, /workspaces, /webapps, or any other path that does not begin with /ni…, include the service prefix in baseUrl.
• If the operation URL already starts with /nifeed, /niapm, /nisysmgmt, /niworkitem, /niworkorder, /ninotebook, etc., use the bare server origin as baseUrl.

When in doubt, check the URL of any operation exported by that service's generated client.

Services with path-prefixed base URLs

These services have operation URLs that do not include the service prefix (e.g. /v2/subscriptions, /users, /webapps), so the prefix must be part of baseUrl:

| Service | Required baseUrl | | ----------------- | ------------------------------------------------ | | tags | https://your-server.example.com/nitag | | user | https://your-server.example.com/niuser/v1 | | web-application | https://your-server.example.com/niapp/v1 | | file-ingestion | https://your-server.example.com/nifile | | test-monitor | https://your-server.example.com/nitestmonitor | | tag-historian | https://your-server.example.com/nitaghistorian |

Bare origin services — use https://your-server.example.com (no suffix) because their generated operation URLs already include the full service path:

| Service | Example operation URL | | -------------------- | ----------------------------- | | alarm | /nialarm/v1/instances | | feeds | /nifeed/v1/feeds | | asset-management | /niapm/v1/assets | | systems-management | /nisysmgmt/v1/jobs | | notebook | /ninotebook/v1/notebook/... | | work-item | /niworkitem/v1/workitems | | work-order | /niworkorder/v1/testplans |

All remaining services follow the same bare-origin pattern.

Regenerating the API clients

The clients are generated from live OpenAPI specs hosted at dev-api.lifecyclesolutions.ni.com.
To regenerate after a spec update:

npm run generate          # regenerate all 27 clients
npm run generate:exports  # update package.json exports map (if services changed)
npm run build             # compile new sources

Development

npm run build          # compile ESM + CJS + type declarations → dist/
npm run build:watch    # watch mode
npm run typecheck      # TypeScript type check (no emit)

# Integration tests (requires a real SystemLink server)
cp .env.example .env   # fill in SYSTEMLINK_API_URL and SYSTEMLINK_API_KEY
npm test

Change files

This project uses beachball for semantic versioning. Before submitting a PR, create a change file:

npm run change

See CONTRIBUTING.md for full details.