# @uptime.link/interfaces

Documentation for @uptime.link/interfaces

# readme.md for @uptime.link/interfaces

TypeScript interface for the uptime.link API and modules

## Availabililty and Links
* [npmjs.org (npm package)](https://www.npmjs.com/package/@uptime.link/interfaces)
* [gitlab.com (source)](https://gitlab.com/uptime.link/interfaces)
* [github.com (source mirror)](https://github.com/uptime.link/interfaces)
* [docs (typedoc)](https://uptime.link.gitlab.io/interfaces/)

## Status for master

Status Category | Status Badge
-- | --
GitLab Pipelines | [![pipeline status](https://gitlab.com/uptime.link/interfaces/badges/master/pipeline.svg)](https://lossless.cloud)
GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/uptime.link/interfaces/badges/master/coverage.svg)](https://lossless.cloud)
npm | [![npm downloads per month](https://badgen.net/npm/dy/@uptime.link/interfaces)](https://lossless.cloud)
Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/uptime.link/interfaces)](https://lossless.cloud)
TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@uptime.link/interfaces)](https://lossless.cloud)
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@uptime.link/interfaces)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@uptime.link/interfaces)](https://lossless.cloud)

## Usage

## Contribution

We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)

## Contribution

We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)

For further information read the linked docs at the top of this readme.

## Legal
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)

# changelog.md for @uptime.link/interfaces

## 2025-12-26 - 2.1.0 - feat(interfaces)
add structured data models and discriminated check configs; migrate tooling and package metadata

- Introduce TCheckConfig union and typed check config interfaces (IAssumptionCheckConfig, IFunctionCheckConfig, IPwaCheckConfig, IPageRankCheckConfig) and TExecutionTiming for runtimes
- Extend ICheckCollection to support a unified checks array while preserving legacy per-type arrays for backward compatibility
- Add service and status-page models (IServiceStatus, IOverallStatus, IServiceGroup, IStatusPageConfig) and richer incident types (IIncident, IIncidentUpdate) plus a legacy IIncidentLegacy shim
- Export central data index enhancements (re-exports for checks and types) and add new data files (types.ts, checks/index.ts, servicestatus.ts, statuspageconfig.ts)
- Migrate plugin and dependency namespaces (@apiglobal/... -> @api.global/..., @gitzone/* -> @git.zone/*) and update dependency versions
- Add npmextra release configuration (registries and accessLevel) and adjust tsconfig for NodeNext module resolution and verbatimModuleSyntax

## 2023-04-19 - 2.0.21 - core
Maintenance release with a series of core fixes and minor updates.

- Aggregated patch-level fixes and stability improvements applied across the 2.0.x line.
- Includes maintenance changes introduced in 2.0.4 through 2.0.21 (core updates, bug fixes, small adjustments).
- No breaking API changes.

## 2022-07-19 - 2.0.3 - core
Patch releases preparing and stabilizing the 2.0 series.

- Multiple small core updates and fixes delivered in 2.0.0 through 2.0.3.
- General maintenance and reliability improvements; no breaking changes.

## 2022-07-16 - 1.0.10 - core (BREAKING CHANGE)
Switch from CommonJS to ECMAScript Modules (ESM).

- BREAKING CHANGE: module system changed to ESM.
- Consumers must update imports/usage accordingly (CommonJS require() calls will need migration).
- Ensure build tools and runtime environments support ESM after this change.

## 2019-11-30 - 1.0.2 - interfaces
Introduce basic interface constructs for page checks.

- Implemented basic constructs for pagechecks under interfaces.
- Foundation for further interface-driven checks and validations.

## 2019-11-30 → 2021-03-08 - 1.0.3–1.0.9 - maintenance
Series of patch releases with minor fixes and updates.

- Multiple small fixes and maintenance updates across 1.0.3 through 1.0.9.
- General stability and housekeeping changes; no notable feature additions or breaking changes.