Compare commits

..

52 Commits

Author SHA1 Message Date
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
35 changed files with 4888 additions and 1808 deletions

4
.gitignore vendored

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

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

24
.vscode/launch.json vendored

@ -2,28 +2,10 @@
"version": "0.2.0", "version": "0.2.0",
"configurations": [ "configurations": [
{ {
"name": "current file", "command": "npm test",
"type": "node", "name": "Run npm test",
"request": "launch", "request": "launch",
"args": [ "type": "node-terminal"
"${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"
} }
] ]
} }

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

@ -1,11 +1,12 @@
{ {
"gitzone": { "gitzone": {
"projectType": "npm",
"module": { "module": {
"githost": "gitlab.com", "githost": "gitlab.com",
"gitscope": "uptimelink", "gitscope": "uptime.link",
"gitrepo": "interfaces", "gitrepo": "interfaces",
"shortDescription": "TypeScript interface for the uptime.link API and modules", "description": "TypeScript interface for the uptime.link API and modules",
"npmPackagename": "@uptimelink/interfaces", "npmPackagename": "@uptime.link/interfaces",
"license": "MIT", "license": "MIT",
"projectDomain": "uptime.link" "projectDomain": "uptime.link"
} }

1635
package-lock.json generated

File diff suppressed because it is too large Load Diff

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

4464
pnpm-lock.yaml generated Normal file

File diff suppressed because it is too large Load Diff

@ -1,23 +1,32 @@
# @uptimelink/interfaces # @uptime.link/interfaces
TypeScript interface for the uptime.link API and modules TypeScript interface for the uptime.link API and modules
## Availabililty and Links ## Availabililty and Links
* [npmjs.org (npm package)](https://www.npmjs.com/package/@uptimelink/interfaces) * [npmjs.org (npm package)](https://www.npmjs.com/package/@uptime.link/interfaces)
* [gitlab.com (source)](https://gitlab.com/uptimelink/interfaces) * [gitlab.com (source)](https://gitlab.com/uptime.link/interfaces)
* [github.com (source mirror)](https://github.com/uptimelink/interfaces) * [github.com (source mirror)](https://github.com/uptime.link/interfaces)
* [docs (typedoc)](https://uptimelink.gitlab.io/interfaces/) * [docs (typedoc)](https://uptime.link.gitlab.io/interfaces/)
## Status for master ## 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) Status Category | Status Badge
[![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) GitLab Pipelines | [![pipeline status](https://gitlab.com/uptime.link/interfaces/badges/master/pipeline.svg)](https://lossless.cloud)
[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/) GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/uptime.link/interfaces/badges/master/coverage.svg)](https://lossless.cloud)
[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/) npm | [![npm downloads per month](https://badgen.net/npm/dy/@uptime.link/interfaces)](https://lossless.cloud)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/) 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 ## 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 ## 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. 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) | 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)

@ -1,9 +1,10 @@
import { expect, tap } from '@pushrocks/tapbundle'; import { expect, tap } from '@pushrocks/tapbundle';
import * as interfaces from '../ts/index'; import * as interfaces from '../ts/index.js';
tap.test('first test', async () => { 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(); tap.start();

8
ts/00_commitinfo_data.ts Normal file

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

@ -0,0 +1,13 @@
import * as plugins from '../ul-interfaces.plugins.js';
import * as search from './search.js';
import * as checks from './checks/index.js';
export interface ICheckCollection {
id: string;
intervalMs: number;
assumptionChecks?: Array<checks.IAssumptionCheck>;
functionChecks: Array<checks.IFunctionCheck>;
pwaChecks?: Array<checks.IPwaCheck>;
pageRankChecks: Array<checks.IPageRankCheck>;
}

@ -0,0 +1,23 @@
import * as plugins from '../../ul-interfaces.plugins.js';
import { TCheckResultStatus, TExecutionTiming } from './index.js';
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>;
};
}>;
}

@ -0,0 +1,15 @@
import { TCheckResultStatus, TExecutionTiming } from './index.js';
export interface IFunctionCheck {
checkId: string;
inputData: {
domain: string;
functionDef: string;
};
executionResults: Array<{
timing: TExecutionTiming;
status: TCheckResultStatus;
data: any;
checkLog: string[];
}>;
}

13
ts/data/checks/index.ts Normal file

@ -0,0 +1,13 @@
export type TCheckResultStatus = 'ok' | 'not ok' | 'timed out';
export interface TExecutionTiming {
plannedTime: number;
timeStarted: number;
timeEnded: number;
duration: number;
}
export * from './assumption.check.js';
export * from './function.check.js';
export * from './pagerank.check.js';
export * from './pwa.check.js';

@ -0,0 +1,19 @@
import * as search from '../search.js';
import { TCheckResultStatus, TExecutionTiming } from './index.js';
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;
}>;
}

@ -0,0 +1,16 @@
import { TCheckResultStatus } from './index.js';
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

@ -0,0 +1,31 @@
import * as plugins from '../ul-interfaces.plugins.js';
import { 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;
}[];
}

22
ts/data/incident.ts Normal file

@ -0,0 +1,22 @@
import * as plugins from '../ul-interfaces.plugins.js';
export interface IIncident {
timestamp: number;
firstResponseTimestamp?: number;
/**
* indicates
*/
status: 'discovered' | 'investigating' | 'fixing' | 'fixImplemented' | 'watching' | 'resolved';
creationMode: 'monitor' | 'manual';
assignedUserId?: string;
postMortemLink?: string;
updates: {
markdownText: string;
type: 'comment' | 'manualUpdate' | 'automaticUpdate';
}[];
justForLooks: {
isoTimestamp: string;
};
}

11
ts/data/index.ts Normal file

@ -0,0 +1,11 @@
export * from './checkcollection.js';
export * from './domainsnapshot.js';
export * from './incident.js';
export * from './linksnapshot.js';
export * from './property.js';
export * from './search.js';
export * from './status.js';
import * as checks from './checks/index.js';
export { checks };

29
ts/data/linksnapshot.ts Normal 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

@ -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

@ -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[];
};
}

12
ts/data/status.ts Normal 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[];
}

@ -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 { export { requests, data };
checkRequests as pagechecks
};

4
ts/requests/index.ts Normal 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';

@ -0,0 +1,16 @@
import { 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;
};
}

@ -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[];
};
}

@ -0,0 +1,18 @@
import { IDomainSnapshot } from '../data/domainsnapshot.js';
import { 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;
};
}

@ -0,0 +1,17 @@
import * as plugins from '../ul-interfaces.plugins.js';
import * as data from '../data/index.js';
import { 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

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

@ -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[];
};
}

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

10
tsconfig.json Normal file

@ -0,0 +1,10 @@
{
"compilerOptions": {
"experimentalDecorators": true,
"useDefineForClassFields": false,
"target": "ES2022",
"module": "ES2022",
"moduleResolution": "nodenext",
"esModuleInterop": true
}
}

@ -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"
}