54 Commits

Author SHA1 Message Date
29ee77b3d6 v2.1.0 2025-12-26 18:20:01 +00:00
da0bdc0564 feat(interfaces): add structured data models and discriminated check configs; migrate tooling and package metadata 2025-12-26 18:20:01 +00:00
add4a52635 2.0.21 2023-04-19 21:48:16 +02:00
de3ac113fc fix(core): update 2023-04-19 21:48:16 +02:00
2cf760d788 2.0.20 2023-04-19 20:40:22 +02:00
b9a23d5497 fix(core): update 2023-04-19 20:40:21 +02:00
1c196ea31a 2.0.19 2023-04-18 17:13:46 +02:00
d1088270bc fix(core): update 2023-04-18 17:13:45 +02:00
e7a11c2b54 2.0.18 2023-04-17 14:54:27 +02:00
9d8985d67a fix(core): update 2023-04-17 14:54:26 +02:00
5afbf16906 2.0.17 2023-04-17 13:56:55 +02:00
1ef7737dc9 fix(core): update 2023-04-17 13:56:55 +02:00
4d961003e8 2.0.16 2023-04-17 13:54:47 +02:00
24762468da fix(core): update 2023-04-17 13:54:47 +02:00
4c57804da2 2.0.15 2023-04-17 13:48:33 +02:00
847f3a4f1c fix(core): update 2023-04-17 13:48:32 +02:00
d5d896a91e 2.0.14 2023-04-17 13:47:58 +02:00
53b732a3f7 fix(core): update 2023-04-17 13:47:58 +02:00
f7f75a64db 2.0.13 2023-04-10 14:09:21 +02:00
2a0aa6db07 fix(core): update 2023-04-10 14:09:21 +02:00
6a4849f87d 2.0.12 2023-04-10 14:04:13 +02:00
6ba521c1b9 fix(core): update 2023-04-10 14:04:13 +02:00
267dca249f 2.0.11 2023-04-06 19:22:14 +02:00
0b8249a21f fix(core): update 2023-04-06 19:22:13 +02:00
cf4d90ecbd 2.0.10 2023-04-06 18:15:13 +02:00
92d9f441d1 fix(core): update 2023-04-06 18:15:12 +02:00
44d62df972 2.0.9 2023-04-03 17:12:02 +02:00
289ddfc153 fix(core): update 2023-04-03 17:12:01 +02:00
a1cef67eee 2.0.8 2023-04-03 14:41:10 +02:00
5b75506634 fix(core): update 2023-04-03 14:41:09 +02:00
66ed64548a 2.0.7 2023-04-03 14:12:54 +02:00
31888a7f07 fix(core): update 2023-04-03 14:12:53 +02:00
a49f1cd110 2.0.6 2023-04-03 13:52:28 +02:00
9b7f76b22a fix(core): update 2023-04-03 13:52:27 +02:00
5f89befa03 2.0.5 2023-04-03 13:50:23 +02:00
84a2f67df9 fix(core): update 2023-04-03 13:50:22 +02:00
9022721d51 2.0.4 2023-04-03 13:40:57 +02:00
8e9c6be7e0 fix(core): update 2023-04-03 13:40:56 +02:00
a1bf280a2f 2.0.3 2022-07-19 17:17:57 +02:00
3391e0cea3 fix(core): update 2022-07-19 17:17:57 +02:00
5d7167b24a 2.0.2 2022-07-19 17:16:37 +02:00
df2563f501 fix(core): update 2022-07-19 17:16:37 +02:00
ac8a8653e1 2.0.1 2022-07-19 15:52:50 +02:00
1119e5f790 fix(core): update 2022-07-19 15:52:49 +02:00
5b8fa6ebb7 2.0.0 2022-07-16 17:45:10 +02:00
4f8107221b BREAKING CHANGE(core): switch to esm 2022-07-16 17:45:10 +02:00
5887eefbca 1.0.10 2021-09-26 16:11:41 +02:00
615fb17baa fix(core): update 2021-09-26 16:11:41 +02:00
cba5c17252 1.0.9 2021-03-08 17:30:04 +00:00
04604770b1 fix(core): update 2021-03-08 17:30:04 +00:00
193c3970b6 1.0.8 2019-11-30 21:17:19 +00:00
7c30df9d08 fix(core): update 2019-11-30 21:17:18 +00:00
3a11fc8e24 1.0.7 2019-11-30 19:04:10 +00:00
5ce1997085 1.0.6 2019-11-30 18:54:10 +00:00
39 changed files with 8926 additions and 1814 deletions

4
.gitignore vendored
View File

@@ -15,8 +15,6 @@ node_modules/
# builds
dist/
dist_web/
dist_serve/
dist_ts_web/
dist_*/
# custom

View File

@@ -12,29 +12,38 @@ stages:
- release
- metadata
before_script:
- pnpm install -g pnpm
- pnpm install -g @shipzone/npmci
- npmci npm prepare
# ====================
# security stage
# ====================
mirror:
# ====================
# security stage
# ====================
auditProductionDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security
script:
- npmci git mirror
- npmci command npm config set registry https://registry.npmjs.org
- npmci command pnpm audit --audit-level=high --prod
tags:
- lossless
- docker
- notpriv
allow_failure: true
snyk:
image: registry.gitlab.com/hosttoday/ht-docker-node:snyk
auditDevDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security
script:
- npmci npm prepare
- npmci command npm install --ignore-scripts
- npmci command snyk test
- npmci command npm config set registry https://registry.npmjs.org
- npmci command pnpm audit --audit-level=high --dev
tags:
- lossless
- docker
- notpriv
allow_failure: true
# ====================
# test stage
@@ -43,28 +52,22 @@ snyk:
testStable:
stage: test
script:
- npmci npm prepare
- npmci node install stable
- npmci npm install
- npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- lossless
- docker
- priv
testBuild:
stage: test
script:
- npmci npm prepare
- npmci node install stable
- npmci npm install
- npmci command npm run build
- npmci npm build
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- lossless
- docker
- notpriv
release:
stage: release
@@ -84,11 +87,12 @@ release:
codequality:
stage: metadata
allow_failure: true
only:
- tags
script:
- npmci command npm install -g tslint typescript
- npmci command npm install -g typescript
- npmci npm prepare
- npmci npm install
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
tags:
- lossless
- docker
@@ -108,11 +112,9 @@ trigger:
pages:
stage: metadata
script:
- npmci node install lts
- npmci command npm install -g @gitzone/tsdoc
- npmci npm prepare
- npmci node install stable
- npmci npm install
- npmci command tsdoc
- npmci command npm run buildDocs
tags:
- lossless
- docker

24
.vscode/launch.json vendored
View File

@@ -2,28 +2,10 @@
"version": "0.2.0",
"configurations": [
{
"name": "current file",
"type": "node",
"command": "npm test",
"name": "Run npm test",
"request": "launch",
"args": [
"${relativeFile}"
],
"runtimeArgs": ["-r", "@gitzone/tsrun"],
"cwd": "${workspaceRoot}",
"protocol": "inspector",
"internalConsoleOptions": "openOnSessionStart"
},
{
"name": "test.ts",
"type": "node",
"request": "launch",
"args": [
"test/test.ts"
],
"runtimeArgs": ["-r", "@gitzone/tsrun"],
"cwd": "${workspaceRoot}",
"protocol": "inspector",
"internalConsoleOptions": "openOnSessionStart"
"type": "node-terminal"
}
]
}

View File

@@ -11,7 +11,13 @@
},
"gitzone": {
"type": "object",
"description": "settings for gitzone"
"description": "settings for gitzone",
"properties": {
"projectType": {
"type": "string",
"enum": ["website", "element", "service", "npm", "wcc"]
}
}
}
}
}

43
changelog.md Normal file
View File

@@ -0,0 +1,43 @@
# Changelog
## 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.31.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.

View File

@@ -1,17 +1,24 @@
{
"gitzone": {
"@git.zone/cli": {
"projectType": "npm",
"module": {
"githost": "gitlab.com",
"gitscope": "uptimelink",
"gitscope": "uptime.link",
"gitrepo": "interfaces",
"shortDescription": "TypeScript interface for the uptime.link API and modules",
"npmPackagename": "@uptimelink/interfaces",
"description": "TypeScript interface for the uptime.link API and modules",
"npmPackagename": "@uptime.link/interfaces",
"license": "MIT",
"projectDomain": "uptime.link"
},
"release": {
"registries": [
"https://verdaccio.lossless.digital",
"https://registry.npmjs.org"
],
"accessLevel": "public"
}
},
"npmci": {
"npmGlobalTools": [],
"npmAccessLevel": "public"
"@ship.zone/szci": {
"npmGlobalTools": []
}
}

1635
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,37 +1,41 @@
{
"name": "@uptimelink/interfaces",
"version": "1.0.5",
"name": "@uptime.link/interfaces",
"version": "2.1.0",
"private": false,
"description": "TypeScript interface for the uptime.link API and modules",
"main": "dist/index.js",
"typings": "dist/index.d.ts",
"main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts",
"type": "module",
"author": "Lossless GmbH",
"license": "MIT",
"scripts": {
"test": "(tstest test/)",
"build": "(tsbuild)",
"format": "(gitzone format)"
"build": "(tsbuild --web)",
"buildDocs": "tsdoc"
},
"devDependencies": {
"@gitzone/tsbuild": "^2.0.22",
"@gitzone/tstest": "^1.0.15",
"@pushrocks/tapbundle": "^3.0.7",
"@types/node": "^10.11.7",
"tslint": "^5.11.0",
"tslint-config-prettier": "^1.15.0"
"@git.zone/tsbuild": "^4.0.2",
"@git.zone/tsrun": "^2.0.1",
"@git.zone/tstest": "^3.1.3",
"@types/node": "^25.0.3"
},
"dependencies": {
"@apiglobal/typedrequest-interfaces": "^1.0.10"
"@api.global/typedrequest-interfaces": "^3.0.19",
"@tsclass/tsclass": "^9.3.0"
},
"files": [
"ts/**/*",
"ts_web/**/*",
"dist/**/*",
"dist_web/**/*",
"dist_*/**/*",
"dist_ts/**/*",
"dist_ts_web/**/*",
"assets/**/*",
"cli.js",
"npmextra.json",
"readme.md"
],
"browserslist": [
"last 1 chrome versions"
]
}

8046
pnpm-lock.yaml generated Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -1,23 +1,32 @@
# @uptimelink/interfaces
# @uptime.link/interfaces
TypeScript interface for the uptime.link API and modules
## Availabililty and Links
* [npmjs.org (npm package)](https://www.npmjs.com/package/@uptimelink/interfaces)
* [gitlab.com (source)](https://gitlab.com/uptimelink/interfaces)
* [github.com (source mirror)](https://github.com/uptimelink/interfaces)
* [docs (typedoc)](https://uptimelink.gitlab.io/interfaces/)
* [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
[![build status](https://gitlab.com/uptimelink/interfaces/badges/master/build.svg)](https://gitlab.com/uptimelink/interfaces/commits/master)
[![coverage report](https://gitlab.com/uptimelink/interfaces/badges/master/coverage.svg)](https://gitlab.com/uptimelink/interfaces/commits/master)
[![npm downloads per month](https://img.shields.io/npm/dm/@uptimelink/interfaces.svg)](https://www.npmjs.com/package/@uptimelink/interfaces)
[![Known Vulnerabilities](https://snyk.io/test/npm/@uptimelink/interfaces/badge.svg)](https://snyk.io/test/npm/@uptimelink/interfaces)
[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
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
@@ -25,7 +34,6 @@ We are always happy for code contributions. If you are not the code contributing
For further information read the linked docs at the top of this readme.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
## 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)
[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

View File

@@ -1,9 +1,10 @@
import { expect, tap } from '@pushrocks/tapbundle';
import * as interfaces from '../ts/index';
import { expect, tap } from '@git.zone/tstest/tapbundle';
import * as interfaces from '../ts/index.js';
tap.test('first test', async () => {
console.log('hi' as interfaces.pagechecks.IRequest_PageCheck_Assumption['request']['domain']);
console.log(
'hi' as interfaces.requests.IRequest_CheckExchange['request']['checkCollection']['id']
);
});
tap.start();

8
ts/00_commitinfo_data.ts Normal file
View File

@@ -0,0 +1,8 @@
/**
* autocreated commitinfo by @push.rocks/commitinfo
*/
export const commitinfo = {
name: '@uptime.link/interfaces',
version: '2.1.0',
description: 'TypeScript interface for the uptime.link API and modules'
}

View File

@@ -0,0 +1,24 @@
import type * as checks from './checks/index.js';
/**
* A collection of checks to run against a property/service.
*
* Two storage modes supported:
* 1. Legacy: Separate arrays for each check type (assumptionChecks, functionChecks, etc.)
* 2. Modern: Single unified array using discriminated union (checks)
*/
export interface ICheckCollection {
id: string;
name?: string;
description?: string;
intervalMs: number;
// Modern: Single array with discriminated union
checks?: checks.TCheckConfig[];
// Legacy: Separate arrays by type (for backward compatibility)
assumptionChecks?: checks.IAssumptionCheck[];
functionChecks?: checks.IFunctionCheck[];
pwaChecks?: checks.IPwaCheck[];
pageRankChecks?: checks.IPageRankCheck[];
}

View File

@@ -0,0 +1,28 @@
import type * as plugins from '../../ul-interfaces.plugins.js';
import type { TCheckResultStatus } from '../types.js';
import type { TExecutionTiming } from './index.js';
/**
* Assumption check execution data.
* Used by check runners to store input and results.
*/
export interface IAssumptionCheck {
inputData: {
domain: string;
title?: string;
statusCode?: string;
description?: string;
dnsRecords?: plugins.tsclass.network.IDnsRecord;
};
executionResults: Array<{
timing: TExecutionTiming;
status: TCheckResultStatus;
data: {
domain: string;
title?: string;
statusCode?: string;
description?: string;
dnsRecords: Array<plugins.tsclass.network.IDnsRecord>;
};
}>;
}

View File

@@ -0,0 +1,20 @@
import type { TCheckResultStatus } from '../types.js';
import type { TExecutionTiming } from './index.js';
/**
* Function check execution data.
* Used by check runners to store input and results.
*/
export interface IFunctionCheck {
checkId: string;
inputData: {
domain: string;
functionDef: string;
};
executionResults: Array<{
timing: TExecutionTiming;
status: TCheckResultStatus;
data: any;
checkLog: string[];
}>;
}

117
ts/data/checks/index.ts Normal file
View File

@@ -0,0 +1,117 @@
import type { TStatusType, TCheckResultStatus, TCheckLastResult } from '../types.js';
// ============================================
// Execution Timing (used by check runners)
// ============================================
export interface TExecutionTiming {
plannedTime: number;
timeStarted: number;
timeEnded: number;
duration: number;
}
// Re-export for backward compatibility
export type { TCheckResultStatus };
// ============================================
// Check Configuration Base Interface
// ============================================
/**
* Base interface for all check configurations.
* Extended by discriminated variants.
*/
export interface ICheckBase {
id: string;
name: string;
description?: string;
enabled: boolean;
intervalMs?: number;
lastRun?: number;
lastResult?: TCheckLastResult;
}
// ============================================
// Discriminated Check Variants (Configuration)
// ============================================
/**
* Assumption check - assumes a status without active verification
*/
export interface IAssumptionCheckConfig extends ICheckBase {
checkType: 'assumption';
assumedStatus: TStatusType;
domain?: string;
title?: string;
statusCode?: string;
}
/**
* Function check - calls a URL and validates response
*/
export interface IFunctionCheckConfig extends ICheckBase {
checkType: 'function';
functionUrl: string;
domain?: string;
expectedStatusCode?: number;
timeoutMs?: number;
headers?: Record<string, string>;
}
/**
* PWA check - validates Progressive Web App criteria
*/
export interface IPwaCheckConfig extends ICheckBase {
checkType: 'pwa';
targetUrl: string;
domain?: string;
lighthouseThreshold?: number;
categories?: ('performance' | 'accessibility' | 'best-practices' | 'seo')[];
}
/**
* PageRank check - validates search engine ranking
*/
export interface IPageRankCheckConfig extends ICheckBase {
checkType: 'pagerank';
targetUrl: string;
domain?: string;
searchTerm: string;
minimumRank?: number;
checkGoogle?: boolean;
checkBing?: boolean;
googleMinRank?: number;
bingMinRank?: number;
}
// ============================================
// Union Type (for UI and generic handling)
// ============================================
/**
* Union of all check configuration types.
* Use `checkType` discriminant for type narrowing.
*
* @example
* function handleCheck(check: TCheckConfig) {
* if (check.checkType === 'function') {
* console.log(check.functionUrl); // TypeScript knows this exists
* }
* }
*/
export type TCheckConfig =
| IAssumptionCheckConfig
| IFunctionCheckConfig
| IPwaCheckConfig
| IPageRankCheckConfig;
// ============================================
// Execution Interfaces (Runtime Data)
// ============================================
// Keep existing execution interfaces for backward compatibility
export * from './assumption.check.js';
export * from './function.check.js';
export * from './pagerank.check.js';
export * from './pwa.check.js';

View File

@@ -0,0 +1,24 @@
import type * as search from '../search.js';
import type { TCheckResultStatus } from '../types.js';
import type { TExecutionTiming } from './index.js';
/**
* PageRank check execution data.
* Used by check runners to store input and results.
*/
export interface IPageRankCheck {
inputData: {
subId: string;
domain: string;
searchTerm: string;
checkBing?: boolean;
checkGoogle?: boolean;
bingMinRank?: number;
googleMinRank?: number;
};
executionResults: Array<{
timing: TExecutionTiming;
status: TCheckResultStatus;
pageRankResult: search.IPageRankResult;
}>;
}

View File

@@ -0,0 +1,22 @@
import type { TCheckResultStatus } from '../types.js';
/**
* PWA check execution data.
* Used by check runners to store input and results.
*/
export interface IPwaCheck {
inputData: {
domain: string;
};
executionResults: Array<{
subId: string;
timeStarted: number;
timeEnded: number;
duration: number;
status: TCheckResultStatus;
data: {
lhr: any;
reports: any[];
};
}>;
}

31
ts/data/domainsnapshot.ts Normal file
View File

@@ -0,0 +1,31 @@
import * as plugins from '../ul-interfaces.plugins.js';
import type { ILinkSnapshot } from './linksnapshot.js';
export interface IDomainSnapshot {
registration: {
isRegistered: boolean;
updatedDate: number;
createdDate: number;
expiryDate: number;
};
delegation: plugins.tsclass.network.IDomainDelegation;
phishingFlags: {
listName: string;
}[];
recordScans: {
identifier: string;
nameservers: string[];
aRecords: plugins.tsclass.network.IDnsRecord[];
aaaaRecords: plugins.tsclass.network.IDnsRecord[];
txtRecords: plugins.tsclass.network.IDnsRecord[];
mxRecords: plugins.tsclass.network.IDnsRecord[];
specialRecords: {
dmarc: plugins.tsclass.network.IDnsRecord[];
}
}[];
linkSnapshots: ILinkSnapshot[];
whoisServers: {
serverUrl: string;
content: string;
}[];
}

81
ts/data/incident.ts Normal file
View File

@@ -0,0 +1,81 @@
import type { TIncidentSeverity, TIncidentStatus } from './types.js';
// ============================================
// Incident Update
// ============================================
/**
* A single update within an incident timeline.
*/
export interface IIncidentUpdate {
id: string;
incidentId: string;
status: TIncidentStatus;
message: string;
createdAt: number;
createdBy?: string;
type?: 'comment' | 'status_change' | 'automatic';
}
// ============================================
// Incident
// ============================================
/**
* Represents an incident affecting one or more services.
*/
export interface IIncident {
id: string;
title: string;
description: string;
severity: TIncidentSeverity;
status: TIncidentStatus;
// Affected services
affectedServiceIds: string[];
// Timeline
createdAt: number;
updatedAt: number;
resolvedAt?: number;
firstResponseAt?: number;
// Updates history
updates: IIncidentUpdate[];
// Metadata
createdBy?: string;
assignedUserId?: string;
creationMode?: 'monitor' | 'manual';
// Scheduled maintenance
isScheduled?: boolean;
scheduledStartTime?: number;
scheduledEndTime?: number;
// Post-incident
postMortemLink?: string;
}
// ============================================
// Legacy Interface (for backward compatibility)
// ============================================
/**
* @deprecated Use IIncident instead
*/
export interface IIncidentLegacy {
timestamp: number;
firstResponseTimestamp?: number;
status: 'discovered' | 'investigating' | 'fixing' | 'fixImplemented' | 'watching' | 'resolved';
creationMode: 'monitor' | 'manual';
assignedUserId?: string;
postMortemLink?: string;
updates: {
markdownText: string;
type: 'comment' | 'manualUpdate' | 'automaticUpdate';
}[];
justForLooks: {
isoTimestamp: string;
};
}

32
ts/data/index.ts Normal file
View File

@@ -0,0 +1,32 @@
// Core types
export * from './types.js';
// Check interfaces (configuration + execution)
export * from './checks/index.js';
// Collections
export * from './checkcollection.js';
// Incidents
export * from './incident.js';
// Service status
export * from './servicestatus.js';
// Status page configuration
export * from './statuspageconfig.js';
// Domain and link snapshots
export * from './domainsnapshot.js';
export * from './linksnapshot.js';
// Property and search
export * from './property.js';
export * from './search.js';
// Status (90-day history)
export * from './status.js';
// Re-export checks namespace for convenience
import * as checks from './checks/index.js';
export { checks };

29
ts/data/linksnapshot.ts Normal file
View File

@@ -0,0 +1,29 @@
import * as plugins from '../ul-interfaces.plugins.js';
export interface ILinkSnapshot {
/**
* the link base on which the snapshot was taken
*/
linkBaseUrl: string;
httpsSupport: boolean;
httpHttpsParity: boolean;
httpToHttpsRedirect: boolean;
fromWwwRedirect: boolean;
toWwwRedirect: boolean;
statusCode: number;
fullPageLoadSize: number;
fullPageLoadTimeMs: number;
cookies: any[];
httpRequest: {
statusCode: number;
headers: {
[key: string]: string;
}
};
httpsRequest: {
statusCode: number;
headers: {
[key: string]: string;
}
};
}

10
ts/data/property.ts Normal file
View File

@@ -0,0 +1,10 @@
import * as plugins from '../ul-interfaces.plugins.js';
export class IUplinkProperty {
wgOrgIdRef: string;
wgPropertyIdRef: string;
name: string;
type: 'website' | 'app' | 'api' | 'other';
access: 'private' | 'public' | 'auth';
checkCollectionIdRefs: string[];
}

21
ts/data/search.ts Normal file
View File

@@ -0,0 +1,21 @@
export interface ISearchResult {
searchTerm: string;
targetUrl: string;
title: string;
description: string;
rank: number;
}
/**
* special data returned by the PageRankCheck check class
*/
export interface IPageRankResult {
googleRank: number;
googleBlocked: boolean;
bingRank: number;
bingBlocked: boolean;
searchResults: {
google: ISearchResult[];
bing: ISearchResult[];
};
}

64
ts/data/servicestatus.ts Normal file
View File

@@ -0,0 +1,64 @@
import type { TStatusType, TStatusMode, TCheckType } from './types.js';
// ============================================
// Service Status
// ============================================
/**
* Represents the status of a monitored service.
*/
export interface IServiceStatus {
id: string;
name: string;
displayName: string;
description?: string;
// Current state
currentStatus: TStatusType;
lastChecked: number;
responseTime: number;
// Uptime metrics
uptime30d: number;
uptime90d: number;
// Organization
category?: string;
dependencies?: string[];
// Status management
statusMode: TStatusMode;
manualStatus?: TStatusType;
paused: boolean;
// Check configuration
checkType?: TCheckType;
checkCollectionId?: string;
intervalMs?: number;
}
// ============================================
// Status History
// ============================================
/**
* A point in the status history timeline.
*/
export interface IStatusHistoryPoint {
timestamp: number;
status: TStatusType;
responseTime?: number;
}
// ============================================
// Overall Status
// ============================================
/**
* Aggregate status for a group of services or entire status page.
*/
export interface IOverallStatus {
status: TStatusType;
message?: string;
lastUpdated: number;
}

12
ts/data/status.ts Normal file
View File

@@ -0,0 +1,12 @@
import * as plugins from '../ul-interfaces.plugins.js';
export interface IStatus {
last90days: IDailyStatus[];
}
export interface IDailyStatus {
timezone: 'UTC';
date: plugins.tsclass.general.IDate;
overallStatus: 'ok' | 'reduced' | 'outage';
incidentRefs: string[];
}

View File

@@ -0,0 +1,57 @@
import type { IOverallStatus } from './servicestatus.js';
// ============================================
// Service Group
// ============================================
/**
* A group of related services displayed together.
*/
export interface IServiceGroup {
id: string;
name: string;
description?: string;
serviceIds: string[];
expanded: boolean;
order?: number;
}
// ============================================
// Status Page Configuration
// ============================================
/**
* Configuration for a public status page.
*/
export interface IStatusPageConfig {
id: string;
name: string;
slug: string;
// Branding
logoUrl?: string;
faviconUrl?: string;
primaryColor?: string;
customCss?: string;
// Content
headerTitle: string;
headerDescription?: string;
footerText?: string;
// Features
showHistoricalUptime: boolean;
showResponseTime: boolean;
showSubscribeButton: boolean;
showIncidentHistory: boolean;
// Service grouping
serviceGroups: IServiceGroup[];
// Overall status override
overallStatus?: IOverallStatus;
// Custom domain
customDomain?: string;
sslEnabled?: boolean;
}

63
ts/data/types.ts Normal file
View File

@@ -0,0 +1,63 @@
/**
* Shared type definitions for uptime.link
*/
// ============================================
// Status Types
// ============================================
/**
* Status types for monitors/services
*/
export type TStatusType =
| 'operational'
| 'degraded'
| 'partial_outage'
| 'major_outage'
| 'maintenance'
| 'initializing'
| 'error'
| 'paused';
/**
* Check types (discriminant values for TCheck union)
*/
export type TCheckType = 'assumption' | 'function' | 'pwa' | 'pagerank';
/**
* Status mode for monitors - auto follows checks, manual is user-set
*/
export type TStatusMode = 'auto' | 'manual';
// ============================================
// Incident Types
// ============================================
/**
* Incident severity levels
*/
export type TIncidentSeverity = 'critical' | 'major' | 'minor' | 'maintenance';
/**
* Incident status workflow
*/
export type TIncidentStatus =
| 'investigating'
| 'identified'
| 'monitoring'
| 'resolved'
| 'postmortem';
// ============================================
// Check Result Types (used by execution)
// ============================================
/**
* Result status for check execution
*/
export type TCheckResultStatus = 'ok' | 'not ok' | 'timed out';
/**
* Last result state for a check
*/
export type TCheckLastResult = 'success' | 'failure' | 'pending';

View File

@@ -1,5 +1,4 @@
import * as checkRequests from './ul-interfaces.checkrequest';
import * as requests from './requests/index.js';
import * as data from './data/index.js';
export {
checkRequests as pagechecks
};
export { requests, data };

4
ts/requests/index.ts Normal file
View File

@@ -0,0 +1,4 @@
export * from './requests.checks.js';
export * from './requests.incidents.js';
export * from './requests.snapshot.js';
export * from './requests.status.js';

View File

@@ -0,0 +1,16 @@
import type { ICheckCollection } from '../data/checkcollection.js';
import * as plugins from '../ul-interfaces.plugins.js';
export interface IRequest_CheckExchange
extends plugins.typedRequestInterfaces.implementsTR<
plugins.typedRequestInterfaces.ITypedRequest,
IRequest_CheckExchange
> {
method: 'check';
request: {
checkCollection: ICheckCollection;
};
response: {
checkCollection: ICheckCollection;
};
}

View File

@@ -0,0 +1,17 @@
import * as plugins from '../ul-interfaces.plugins.js';
import * as data from '../data/index.js';
export interface IRequest_Incidents_Get
extends plugins.typedRequestInterfaces.implementsTR<
plugins.typedRequestInterfaces.ITypedRequest,
IRequest_Incidents_Get
> {
method: 'getIncidents';
request: {
userToken?: string;
};
response: {
currentIncidents: data.IIncident[];
pastIncidents: data.IIncident[];
};
}

View File

@@ -0,0 +1,18 @@
import type { IDomainSnapshot } from '../data/domainsnapshot.js';
import type { ILinkSnapshot } from '../data/linksnapshot.js';
import * as plugins from '../ul-interfaces.plugins.js';
export interface IReq_PerformDomainSnapshot
extends plugins.typedRequestInterfaces.implementsTR<
plugins.typedRequestInterfaces.ITypedRequest,
IReq_PerformDomainSnapshot
> {
method: 'performDomainSnapshot';
request: {
domainName: string;
};
response: {
domainSnapshot: IDomainSnapshot;
linkSnapshot: ILinkSnapshot;
};
}

View File

@@ -0,0 +1,17 @@
import * as plugins from '../ul-interfaces.plugins.js';
import * as data from '../data/index.js';
import type { IStatus } from '../data/status.js';
export interface IRequest_Status_Get
extends plugins.typedRequestInterfaces.implementsTR<
plugins.typedRequestInterfaces.ITypedRequest,
IRequest_Status_Get
> {
method: 'getStatus';
request: {
userToken?: string;
};
response: {
status: IStatus;
};
}

5
ts/status.ts Normal file
View File

@@ -0,0 +1,5 @@
export type TServiceStatus = 'up' | 'down';
export interface IHourlyStatus {
states: { unixTimes: number; status: TServiceStatus };
}

View File

@@ -1,67 +0,0 @@
import * as plugins from './ul-interfaces.plugins';
export type TCheckResultStatus = 'ok' | 'not ok' | 'timed out';
export interface IRequest_PageCheck_PWA {
method: 'pwa';
request: {
intervalMs: number,
domain: string;
};
response: {
timeStarted: number;
timeEnded: number;
duration: number;
status: TCheckResultStatus;
data: {
lhr: any;
reports: any[];
};
checkLog: string[];
};
}
export interface IRequest_PageCheck_Function {
method: 'checkPwa';
request: {
intervalMs: number,
domain: string;
functionDef: string;
};
response: {
timeStarted: number;
timeEnded: number;
duration: number;
status: TCheckResultStatus;
data: any;
checkLog: string[];
};
}
export interface IRequest_PageCheck_Assumption {
method: 'assumption';
request: {
intervalMs: number,
domain: string;
title?: string;
statusCode?: string;
description?: string;
dnsRecordMx?: string;
dnsRecordTxt?: string;
};
response: {
timeStarted: number;
timeEnded: number;
duration: number;
status: TCheckResultStatus;
data: {
domain: string;
title?: string;
statusCode?: string;
description?: string;
dnsRecordMx?: string;
dnsRecordTxt?: string;
};
checkLog: string[];
};
}

View File

@@ -1,5 +1,8 @@
import * as typedRequestInterfaces from '@apiglobal/typedrequest-interfaces';
import * as typedRequestInterfaces from '@api.global/typedrequest-interfaces';
export {
typedRequestInterfaces
};
export { typedRequestInterfaces };
// tsclass scope
import * as tsclass from '@tsclass/tsclass';
export { tsclass };

12
tsconfig.json Normal file
View File

@@ -0,0 +1,12 @@
{
"compilerOptions": {
"target": "ES2022",
"module": "NodeNext",
"moduleResolution": "NodeNext",
"esModuleInterop": true,
"verbatimModuleSyntax": true
},
"exclude": [
"dist_*/**/*.d.ts"
]
}

View File

@@ -1,17 +0,0 @@
{
"extends": ["tslint:latest", "tslint-config-prettier"],
"rules": {
"semicolon": [true, "always"],
"no-console": false,
"ordered-imports": false,
"object-literal-sort-keys": false,
"member-ordering": {
"options":{
"order": [
"static-method"
]
}
}
},
"defaultSeverity": "warning"
}