2.0.21

.gitignore

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

.gitlab-ci.yml

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

.vscode/launch.json

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

.vscode/settings.json

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

npmextra.json

@@ -1,11 +1,12 @@
 {
   "gitzone": {
+    "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"
     }

package.json

@@ -1,35 +1,42 @@
 {
-  "name": "@uptimelink/interfaces",
-  "version": "1.0.3",
+  "name": "@uptime.link/interfaces",
+  "version": "2.0.21",
   "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"
+    "@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": "^2.0.1",
+    "@tsclass/tsclass": "^4.0.38"
   },
-  "dependencies": {},
   "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"
   ]
 }

readme.md

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

test/test.ts

@@ -1,8 +1,10 @@
 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(interfaces.standardExport);
+  console.log(
+    'hi' as interfaces.requests.IRequest_CheckExchange['request']['checkCollection']['id']
+  );
 });
 
 tap.start();

ts/00_commitinfo_data.ts

@@ -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'
+}

ts/data/checkcollection.ts

@@ -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>;
+}

ts/data/checks/assumption.check.ts

@@ -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>;
+    };
+  }>;
+}

ts/data/checks/function.check.ts

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

ts/data/checks/index.ts

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

ts/data/checks/pagerank.check.ts

@@ -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;
+  }>;
+}

ts/data/checks/pwa.check.ts

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

ts/data/domainsnapshot.ts

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

ts/data/incident.ts

@@ -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;
+  };
+}

ts/data/index.ts

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

ts/data/linksnapshot.ts

@@ -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;
+    }
+  };
+}

ts/data/property.ts

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

ts/data/search.ts

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

ts/data/status.ts

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

ts/index.ts

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

ts/requests/index.ts

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

ts/requests/requests.checks.ts

@@ -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;
+  };
+}

ts/requests/requests.incidents.ts

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

ts/requests/requests.snapshot.ts

@@ -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;
+  };
+}

ts/requests/requests.status.ts

@@ -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;
+  };
+}

ts/status.ts

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

ts/ul-interfaces.checkrequest.ts

@@ -1,3 +0,0 @@
-export interface IPageCheckRequest {
-  
-}

ts/ul-interfaces.pagechecks.ts

@@ -1,7 +0,0 @@
-export interface IPageCheckSimple {};
-
-export interface IPageCheckAdvanced {};
-
-export interface IPageCheckPWA {
-  
-}

ts/ul-interfaces.plugins.ts

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

tsconfig.json

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

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