Compare commits
46 Commits
Author | SHA1 | Date | |
---|---|---|---|
add4a52635 | |||
de3ac113fc | |||
2cf760d788 | |||
b9a23d5497 | |||
1c196ea31a | |||
d1088270bc | |||
e7a11c2b54 | |||
9d8985d67a | |||
5afbf16906 | |||
1ef7737dc9 | |||
4d961003e8 | |||
24762468da | |||
4c57804da2 | |||
847f3a4f1c | |||
d5d896a91e | |||
53b732a3f7 | |||
f7f75a64db | |||
2a0aa6db07 | |||
6a4849f87d | |||
6ba521c1b9 | |||
267dca249f | |||
0b8249a21f | |||
cf4d90ecbd | |||
92d9f441d1 | |||
44d62df972 | |||
289ddfc153 | |||
a1cef67eee | |||
5b75506634 | |||
66ed64548a | |||
31888a7f07 | |||
a49f1cd110 | |||
9b7f76b22a | |||
5f89befa03 | |||
84a2f67df9 | |||
9022721d51 | |||
8e9c6be7e0 | |||
a1bf280a2f | |||
3391e0cea3 | |||
5d7167b24a | |||
df2563f501 | |||
ac8a8653e1 | |||
1119e5f790 | |||
5b8fa6ebb7 | |||
4f8107221b | |||
5887eefbca | |||
615fb17baa |
@ -12,40 +12,36 @@ stages:
|
||||
- release
|
||||
- metadata
|
||||
|
||||
before_script:
|
||||
- pnpm install -g pnpm
|
||||
- pnpm install -g @shipzone/npmci
|
||||
- npmci npm prepare
|
||||
|
||||
# ====================
|
||||
# security stage
|
||||
# ====================
|
||||
# ====================
|
||||
# security stage
|
||||
# ====================
|
||||
mirror:
|
||||
stage: security
|
||||
script:
|
||||
- npmci git mirror
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
auditProductionDependencies:
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
stage: security
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci command npm install --production --ignore-scripts
|
||||
- npmci command npm config set registry https://registry.npmjs.org
|
||||
- npmci command npm audit --audit-level=high --only=prod --production
|
||||
- npmci command npm config set registry https://registry.npmjs.org
|
||||
- npmci command pnpm audit --audit-level=high --prod
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
allow_failure: true
|
||||
|
||||
auditDevDependencies:
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
stage: security
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci command npm install --ignore-scripts
|
||||
- npmci command npm config set registry https://registry.npmjs.org
|
||||
- npmci command npm audit --audit-level=high --only=dev
|
||||
- npmci command pnpm audit --audit-level=high --dev
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
allow_failure: true
|
||||
|
||||
@ -56,7 +52,6 @@ auditDevDependencies:
|
||||
testStable:
|
||||
stage: test
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
@ -67,10 +62,9 @@ testStable:
|
||||
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:
|
||||
- docker
|
||||
@ -96,10 +90,9 @@ codequality:
|
||||
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
|
||||
@ -119,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
24
.vscode/launch.json
vendored
@ -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"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
@ -3,10 +3,10 @@
|
||||
"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"
|
||||
}
|
||||
|
11652
package-lock.json
generated
11652
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
23
package.json
23
package.json
@ -1,27 +1,28 @@
|
||||
{
|
||||
"name": "@uptimelink/interfaces",
|
||||
"version": "1.0.9",
|
||||
"name": "@uptime.link/interfaces",
|
||||
"version": "2.0.21",
|
||||
"private": false,
|
||||
"description": "TypeScript interface for the uptime.link API and modules",
|
||||
"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.1.25",
|
||||
"@gitzone/tstest": "^1.0.52",
|
||||
"@pushrocks/tapbundle": "^3.2.14",
|
||||
"@types/node": "^14.14.32",
|
||||
"tslint": "^6.1.3",
|
||||
"tslint-config-prettier": "^1.15.0"
|
||||
"@gitzone/tsbuild": "^2.1.65",
|
||||
"@gitzone/tsrun": "^1.2.39",
|
||||
"@gitzone/tstest": "^1.0.74",
|
||||
"@pushrocks/tapbundle": "^5.0.4",
|
||||
"@types/node": "^18.15.11"
|
||||
},
|
||||
"dependencies": {
|
||||
"@apiglobal/typedrequest-interfaces": "^1.0.15"
|
||||
"@apiglobal/typedrequest-interfaces": "^2.0.1",
|
||||
"@tsclass/tsclass": "^4.0.38"
|
||||
},
|
||||
"files": [
|
||||
"ts/**/*",
|
||||
|
4464
pnpm-lock.yaml
generated
Normal file
4464
pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load Diff
31
readme.md
31
readme.md
@ -1,27 +1,26 @@
|
||||
# @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
|
||||
|
||||
Status Category | Status Badge
|
||||
-- | --
|
||||
GitLab Pipelines | [](https://lossless.cloud)
|
||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||
npm | [](https://lossless.cloud)
|
||||
Snyk | [](https://lossless.cloud)
|
||||
GitLab Pipelines | [](https://lossless.cloud)
|
||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||
npm | [](https://lossless.cloud)
|
||||
Snyk | [](https://lossless.cloud)
|
||||
TypeScript Support | [](https://lossless.cloud)
|
||||
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
Code Style | [](https://lossless.cloud)
|
||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||
|
||||
## Usage
|
||||
|
||||
@ -29,14 +28,12 @@ Platform support | [ 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.
|
||||
|
||||
> 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)
|
||||
|
||||
[](https://maintainedby.lossless.com)
|
||||
|
@ -1,9 +1,9 @@
|
||||
import { expect, tap } from '@pushrocks/tapbundle';
|
||||
import * as interfaces from '../ts/index';
|
||||
import * as interfaces from '../ts/index.js';
|
||||
|
||||
tap.test('first test', async () => {
|
||||
console.log(
|
||||
'hi' as interfaces.requests.checkRequests.IRequest_PageCheck_Assumption['request']['domain']
|
||||
'hi' as interfaces.requests.IRequest_CheckExchange['request']['checkCollection']['id']
|
||||
);
|
||||
});
|
||||
|
||||
|
8
ts/00_commitinfo_data.ts
Normal file
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'
|
||||
}
|
13
ts/data/checkcollection.ts
Normal file
13
ts/data/checkcollection.ts
Normal file
@ -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>;
|
||||
}
|
23
ts/data/checks/assumption.check.ts
Normal file
23
ts/data/checks/assumption.check.ts
Normal file
@ -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>;
|
||||
};
|
||||
}>;
|
||||
}
|
15
ts/data/checks/function.check.ts
Normal file
15
ts/data/checks/function.check.ts
Normal file
@ -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
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';
|
19
ts/data/checks/pagerank.check.ts
Normal file
19
ts/data/checks/pagerank.check.ts
Normal file
@ -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;
|
||||
}>;
|
||||
}
|
16
ts/data/checks/pwa.check.ts
Normal file
16
ts/data/checks/pwa.check.ts
Normal file
@ -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
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
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
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
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
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
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
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,3 +1,4 @@
|
||||
import * as requests from './requests';
|
||||
import * as requests from './requests/index.js';
|
||||
import * as data from './data/index.js';
|
||||
|
||||
export { requests };
|
||||
export { requests, data };
|
||||
|
@ -1,3 +1,4 @@
|
||||
import * as checkRequests from './ul-interfaces.checkrequest';
|
||||
|
||||
export { checkRequests };
|
||||
export * from './requests.checks.js';
|
||||
export * from './requests.incidents.js';
|
||||
export * from './requests.snapshot.js';
|
||||
export * from './requests.status.js';
|
||||
|
16
ts/requests/requests.checks.ts
Normal file
16
ts/requests/requests.checks.ts
Normal file
@ -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;
|
||||
};
|
||||
}
|
17
ts/requests/requests.incidents.ts
Normal file
17
ts/requests/requests.incidents.ts
Normal 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[];
|
||||
};
|
||||
}
|
18
ts/requests/requests.snapshot.ts
Normal file
18
ts/requests/requests.snapshot.ts
Normal file
@ -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;
|
||||
};
|
||||
}
|
17
ts/requests/requests.status.ts
Normal file
17
ts/requests/requests.status.ts
Normal file
@ -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;
|
||||
};
|
||||
}
|
@ -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: 'function';
|
||||
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,3 +1,8 @@
|
||||
import * as typedRequestInterfaces from '@apiglobal/typedrequest-interfaces';
|
||||
|
||||
export { typedRequestInterfaces };
|
||||
|
||||
// tsclass scope
|
||||
import * as tsclass from '@tsclass/tsclass';
|
||||
|
||||
export { tsclass };
|
||||
|
10
tsconfig.json
Normal file
10
tsconfig.json
Normal file
@ -0,0 +1,10 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"experimentalDecorators": true,
|
||||
"useDefineForClassFields": false,
|
||||
"target": "ES2022",
|
||||
"module": "ES2022",
|
||||
"moduleResolution": "nodenext",
|
||||
"esModuleInterop": true
|
||||
}
|
||||
}
|
17
tslint.json
17
tslint.json
@ -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"
|
||||
}
|
Loading…
x
Reference in New Issue
Block a user