Compare commits
No commits in common. "master" and "v1.0.9" have entirely different histories.
@ -12,36 +12,40 @@ stages:
|
|||||||
- release
|
- release
|
||||||
- metadata
|
- metadata
|
||||||
|
|
||||||
before_script:
|
# ====================
|
||||||
- pnpm install -g pnpm
|
# security stage
|
||||||
- pnpm install -g @shipzone/npmci
|
# ====================
|
||||||
- npmci npm prepare
|
mirror:
|
||||||
|
stage: security
|
||||||
|
script:
|
||||||
|
- npmci git mirror
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
|
tags:
|
||||||
|
- lossless
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
# ====================
|
|
||||||
# security stage
|
|
||||||
# ====================
|
|
||||||
# ====================
|
|
||||||
# security stage
|
|
||||||
# ====================
|
|
||||||
auditProductionDependencies:
|
auditProductionDependencies:
|
||||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
stage: security
|
stage: security
|
||||||
script:
|
script:
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci command npm install --production --ignore-scripts
|
||||||
- npmci command npm config set registry https://registry.npmjs.org
|
- npmci command npm config set registry https://registry.npmjs.org
|
||||||
- npmci command pnpm audit --audit-level=high --prod
|
- npmci command npm audit --audit-level=high --only=prod --production
|
||||||
tags:
|
tags:
|
||||||
- lossless
|
|
||||||
- docker
|
- docker
|
||||||
allow_failure: true
|
|
||||||
|
|
||||||
auditDevDependencies:
|
auditDevDependencies:
|
||||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
stage: security
|
stage: security
|
||||||
script:
|
script:
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci command npm install --ignore-scripts
|
||||||
- npmci command npm config set registry https://registry.npmjs.org
|
- npmci command npm config set registry https://registry.npmjs.org
|
||||||
- npmci command pnpm audit --audit-level=high --dev
|
- npmci command npm audit --audit-level=high --only=dev
|
||||||
tags:
|
tags:
|
||||||
- lossless
|
|
||||||
- docker
|
- docker
|
||||||
allow_failure: true
|
allow_failure: true
|
||||||
|
|
||||||
@ -52,6 +56,7 @@ auditDevDependencies:
|
|||||||
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
|
||||||
@ -62,9 +67,10 @@ testStable:
|
|||||||
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 npm build
|
- npmci command npm run build
|
||||||
coverage: /\d+.?\d+?\%\s*coverage/
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
@ -90,9 +96,10 @@ codequality:
|
|||||||
only:
|
only:
|
||||||
- tags
|
- tags
|
||||||
script:
|
script:
|
||||||
- npmci command npm install -g typescript
|
- npmci command npm install -g tslint 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
|
||||||
@ -112,9 +119,11 @@ trigger:
|
|||||||
pages:
|
pages:
|
||||||
stage: metadata
|
stage: metadata
|
||||||
script:
|
script:
|
||||||
- npmci node install stable
|
- npmci node install lts
|
||||||
|
- npmci command npm install -g @gitzone/tsdoc
|
||||||
|
- npmci npm prepare
|
||||||
- npmci npm install
|
- npmci npm install
|
||||||
- npmci command npm run buildDocs
|
- npmci command tsdoc
|
||||||
tags:
|
tags:
|
||||||
- lossless
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
|
24
.vscode/launch.json
vendored
24
.vscode/launch.json
vendored
@ -2,10 +2,28 @@
|
|||||||
"version": "0.2.0",
|
"version": "0.2.0",
|
||||||
"configurations": [
|
"configurations": [
|
||||||
{
|
{
|
||||||
"command": "npm test",
|
"name": "current file",
|
||||||
"name": "Run npm test",
|
"type": "node",
|
||||||
"request": "launch",
|
"request": "launch",
|
||||||
"type": "node-terminal"
|
"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"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
@ -3,10 +3,10 @@
|
|||||||
"projectType": "npm",
|
"projectType": "npm",
|
||||||
"module": {
|
"module": {
|
||||||
"githost": "gitlab.com",
|
"githost": "gitlab.com",
|
||||||
"gitscope": "uptime.link",
|
"gitscope": "uptimelink",
|
||||||
"gitrepo": "interfaces",
|
"gitrepo": "interfaces",
|
||||||
"description": "TypeScript interface for the uptime.link API and modules",
|
"shortDescription": "TypeScript interface for the uptime.link API and modules",
|
||||||
"npmPackagename": "@uptime.link/interfaces",
|
"npmPackagename": "@uptimelink/interfaces",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"projectDomain": "uptime.link"
|
"projectDomain": "uptime.link"
|
||||||
}
|
}
|
||||||
|
11652
package-lock.json
generated
Normal file
11652
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
23
package.json
23
package.json
@ -1,28 +1,27 @@
|
|||||||
{
|
{
|
||||||
"name": "@uptime.link/interfaces",
|
"name": "@uptimelink/interfaces",
|
||||||
"version": "2.0.21",
|
"version": "1.0.9",
|
||||||
"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_ts/index.js",
|
"main": "dist_ts/index.js",
|
||||||
"typings": "dist_ts/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 --web)",
|
"build": "(tsbuild)",
|
||||||
"buildDocs": "tsdoc"
|
"format": "(gitzone format)"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@gitzone/tsbuild": "^2.1.65",
|
"@gitzone/tsbuild": "^2.1.25",
|
||||||
"@gitzone/tsrun": "^1.2.39",
|
"@gitzone/tstest": "^1.0.52",
|
||||||
"@gitzone/tstest": "^1.0.74",
|
"@pushrocks/tapbundle": "^3.2.14",
|
||||||
"@pushrocks/tapbundle": "^5.0.4",
|
"@types/node": "^14.14.32",
|
||||||
"@types/node": "^18.15.11"
|
"tslint": "^6.1.3",
|
||||||
|
"tslint-config-prettier": "^1.15.0"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@apiglobal/typedrequest-interfaces": "^2.0.1",
|
"@apiglobal/typedrequest-interfaces": "^1.0.15"
|
||||||
"@tsclass/tsclass": "^4.0.38"
|
|
||||||
},
|
},
|
||||||
"files": [
|
"files": [
|
||||||
"ts/**/*",
|
"ts/**/*",
|
||||||
|
4464
pnpm-lock.yaml
generated
4464
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
31
readme.md
31
readme.md
@ -1,26 +1,27 @@
|
|||||||
# @uptime.link/interfaces
|
# @uptimelink/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/@uptime.link/interfaces)
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@uptimelink/interfaces)
|
||||||
* [gitlab.com (source)](https://gitlab.com/uptime.link/interfaces)
|
* [gitlab.com (source)](https://gitlab.com/uptimelink/interfaces)
|
||||||
* [github.com (source mirror)](https://github.com/uptime.link/interfaces)
|
* [github.com (source mirror)](https://github.com/uptimelink/interfaces)
|
||||||
* [docs (typedoc)](https://uptime.link.gitlab.io/interfaces/)
|
* [docs (typedoc)](https://uptimelink.gitlab.io/interfaces/)
|
||||||
|
|
||||||
## Status for master
|
## Status for master
|
||||||
|
|
||||||
Status Category | Status Badge
|
Status Category | Status Badge
|
||||||
-- | --
|
-- | --
|
||||||
GitLab Pipelines | [](https://lossless.cloud)
|
GitLab Pipelines | [](https://lossless.cloud)
|
||||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||||
npm | [](https://lossless.cloud)
|
npm | [](https://lossless.cloud)
|
||||||
Snyk | [](https://lossless.cloud)
|
Snyk | [](https://lossless.cloud)
|
||||||
TypeScript Support | [](https://lossless.cloud)
|
TypeScript Support | [](https://lossless.cloud)
|
||||||
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||||
Code Style | [](https://lossless.cloud)
|
Code Style | [](https://lossless.cloud)
|
||||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||||
|
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
@ -28,12 +29,14 @@ BundlePhobia (total size when bundled) | [ or [contribute monthly](https://lossless.link/contribute). :)
|
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
|
||||||
|
|
||||||
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). :)
|
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.
|
For further information read the linked docs at the top of this readme.
|
||||||
|
|
||||||
## Legal
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||||
> 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)
|
||||||
|
|
||||||
|
[](https://maintainedby.lossless.com)
|
||||||
|
@ -1,9 +1,9 @@
|
|||||||
import { expect, tap } from '@pushrocks/tapbundle';
|
import { expect, tap } from '@pushrocks/tapbundle';
|
||||||
import * as interfaces from '../ts/index.js';
|
import * as interfaces from '../ts/index';
|
||||||
|
|
||||||
tap.test('first test', async () => {
|
tap.test('first test', async () => {
|
||||||
console.log(
|
console.log(
|
||||||
'hi' as interfaces.requests.IRequest_CheckExchange['request']['checkCollection']['id']
|
'hi' as interfaces.requests.checkRequests.IRequest_PageCheck_Assumption['request']['domain']
|
||||||
);
|
);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
@ -1,8 +0,0 @@
|
|||||||
/**
|
|
||||||
* 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'
|
|
||||||
}
|
|
@ -1,13 +0,0 @@
|
|||||||
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>;
|
|
||||||
}
|
|
@ -1,23 +0,0 @@
|
|||||||
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>;
|
|
||||||
};
|
|
||||||
}>;
|
|
||||||
}
|
|
@ -1,15 +0,0 @@
|
|||||||
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[];
|
|
||||||
}>;
|
|
||||||
}
|
|
@ -1,13 +0,0 @@
|
|||||||
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';
|
|
@ -1,19 +0,0 @@
|
|||||||
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;
|
|
||||||
}>;
|
|
||||||
}
|
|
@ -1,16 +0,0 @@
|
|||||||
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[];
|
|
||||||
};
|
|
||||||
}>;
|
|
||||||
}
|
|
@ -1,31 +0,0 @@
|
|||||||
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;
|
|
||||||
}[];
|
|
||||||
}
|
|
@ -1,22 +0,0 @@
|
|||||||
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;
|
|
||||||
};
|
|
||||||
}
|
|
@ -1,11 +0,0 @@
|
|||||||
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 };
|
|
@ -1,29 +0,0 @@
|
|||||||
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;
|
|
||||||
}
|
|
||||||
};
|
|
||||||
}
|
|
@ -1,10 +0,0 @@
|
|||||||
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[];
|
|
||||||
}
|
|
@ -1,21 +0,0 @@
|
|||||||
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[];
|
|
||||||
};
|
|
||||||
}
|
|
@ -1,12 +0,0 @@
|
|||||||
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,4 +1,3 @@
|
|||||||
import * as requests from './requests/index.js';
|
import * as requests from './requests';
|
||||||
import * as data from './data/index.js';
|
|
||||||
|
|
||||||
export { requests, data };
|
export { requests };
|
||||||
|
@ -1,4 +1,3 @@
|
|||||||
export * from './requests.checks.js';
|
import * as checkRequests from './ul-interfaces.checkrequest';
|
||||||
export * from './requests.incidents.js';
|
|
||||||
export * from './requests.snapshot.js';
|
export { checkRequests };
|
||||||
export * from './requests.status.js';
|
|
||||||
|
@ -1,16 +0,0 @@
|
|||||||
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;
|
|
||||||
};
|
|
||||||
}
|
|
@ -1,17 +0,0 @@
|
|||||||
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[];
|
|
||||||
};
|
|
||||||
}
|
|
@ -1,18 +0,0 @@
|
|||||||
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;
|
|
||||||
};
|
|
||||||
}
|
|
@ -1,17 +0,0 @@
|
|||||||
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;
|
|
||||||
};
|
|
||||||
}
|
|
67
ts/requests/ul-interfaces.checkrequest.ts
Normal file
67
ts/requests/ul-interfaces.checkrequest.ts
Normal file
@ -0,0 +1,67 @@
|
|||||||
|
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,8 +1,3 @@
|
|||||||
import * as typedRequestInterfaces from '@apiglobal/typedrequest-interfaces';
|
import * as typedRequestInterfaces from '@apiglobal/typedrequest-interfaces';
|
||||||
|
|
||||||
export { typedRequestInterfaces };
|
export { typedRequestInterfaces };
|
||||||
|
|
||||||
// tsclass scope
|
|
||||||
import * as tsclass from '@tsclass/tsclass';
|
|
||||||
|
|
||||||
export { tsclass };
|
|
||||||
|
@ -1,10 +0,0 @@
|
|||||||
{
|
|
||||||
"compilerOptions": {
|
|
||||||
"experimentalDecorators": true,
|
|
||||||
"useDefineForClassFields": false,
|
|
||||||
"target": "ES2022",
|
|
||||||
"module": "ES2022",
|
|
||||||
"moduleResolution": "nodenext",
|
|
||||||
"esModuleInterop": true
|
|
||||||
}
|
|
||||||
}
|
|
17
tslint.json
Normal file
17
tslint.json
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
{
|
||||||
|
"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