2.0.2

.gitignore

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

.gitlab-ci.yml

@@ -12,29 +12,35 @@ stages:
   - release
   - metadata
 
+before_script:
+  - npm install -g @shipzone/npmci
+
 # ====================
 # security stage
 # ====================
-mirror:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
-    - npmci git mirror
+    - 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
   tags:
-    - lossless
     - 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
   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 npm audit --audit-level=high --only=dev
   tags:
-    - lossless
     - docker
-    - notpriv
+  allow_failure: true
 
 # ====================
 # test stage
@@ -49,9 +55,7 @@ testStable:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - priv
 
 testBuild:
   stage: test
@@ -62,9 +66,7 @@ testBuild:
     - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - notpriv
 
 release:
   stage: release
@@ -84,11 +86,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 +111,10 @@ trigger:
 pages:
   stage: metadata
   script:
-    - npmci node install lts
+    - npmci node install stable 
-    - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - 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",
+      "command": "npm test",
-      "type": "node",
+      "name": "Run npm test",
       "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"
     }
   ]
 }

.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",
+      "description": "TypeScript interface for the uptime.link API and modules",
-      "npmPackagename": "@uptimelink/interfaces",
+      "npmPackagename": "@uptime.link/interfaces",
       "license": "MIT",
       "projectDomain": "uptime.link"
     }

package.json

@@ -1,35 +1,41 @@
 {
-  "name": "@uptimelink/interfaces",
+  "name": "@uptime.link/interfaces",
-  "version": "1.0.2",
+  "version": "2.0.2",
   "private": false,
   "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",
   "license": "MIT",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild)",
+    "build": "(tsbuild --web)",
-    "format": "(gitzone format)"
+    "buildDocs": "tsdoc"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
+    "@gitzone/tsbuild": "^2.1.63",
-    "@gitzone/tstest": "^1.0.15",
+    "@gitzone/tstest": "^1.0.71",
-    "@pushrocks/tapbundle": "^3.0.7",
+    "@pushrocks/tapbundle": "^5.0.3",
-    "@types/node": "^10.11.7",
+    "@types/node": "^18.0.5"
-    "tslint": "^5.11.0",
+  },
-    "tslint-config-prettier": "^1.15.0"
+  "dependencies": {
+    "@apiglobal/typedrequest-interfaces": "^1.0.15",
+    "@tsclass/tsclass": "^4.0.17"
   },
-  "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,33 @@
-# @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)
+* [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
-[![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)
+Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](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
 

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.checkRequests.IRequest_PageCheck_Assumption['request']['domain']
+  );
 });
 
 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.2',
+  description: 'TypeScript interface for the uptime.link API and modules'
+}

ts/data/checks.ts

@@ -0,0 +1,59 @@
+import * as plugins from '../ul-interfaces.plugins.js';
+
+export type TCheckResultStatus = 'ok' | 'not ok' | 'timed out';
+
+export interface ICheck {
+  type: 'pwa' | 'function' | 'assumption';
+  intervalMs: number;
+  pwaData?: {
+    domain: string;
+  };
+  functionData: {
+    domain: string;
+    functionDef: string;
+  };
+  assumptionData?: {
+    domain: string;
+    title?: string;
+    statusCode?: string;
+    description?: string;
+    dnsRecordMx?: string;
+    dnsRecordTxt?: string;
+  };
+
+  checkResults: Array<{
+    pwaResult?: {
+      timeStarted: number;
+      timeEnded: number;
+      duration: number;
+      status: TCheckResultStatus;
+      data: {
+        lhr: any;
+        reports: any[];
+      };
+    };
+    functionResult?: {
+      timeStarted: number;
+      timeEnded: number;
+      duration: number;
+      status: TCheckResultStatus;
+      data: any;
+      
+    };
+    assumptionResult: {
+      timeStarted: number;
+      timeEnded: number;
+      duration: number;
+      status: TCheckResultStatus;
+      data: {
+        domain: string;
+        title?: string;
+        statusCode?: string;
+        description?: string;
+        dnsRecordMx?: string;
+        dnsRecordTxt?: string;
+      };
+    };
+    checkLog: 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,4 @@
+export * from './checks.js';
+export * from './incident.js';
+export * from './property.js';
+export * from './status.js';

ts/data/property.ts

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

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,3 +1,4 @@
-import * as plugins from './interfaces.plugins';
+import * as requests from './requests/index.js';
+import * as data from './data/index.js';
 
-export let standardExport = 'Hi there! :) This is an exported string';
+export { requests, data };

ts/interfaces.plugins.ts

@@ -1,2 +0,0 @@
-const removeme = {};
-export { removeme };

ts/requests/index.ts

@@ -0,0 +1,3 @@
+import * as checkRequests from './requests.checks.js';
+
+export { checkRequests };

ts/requests/requests.checks.ts

@@ -0,0 +1,16 @@
+import { ICheck } from '../data/checks.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: {
+    check: ICheck;
+  };
+  response: {
+    check: ICheck;
+  }
+}

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.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.plugins.ts

@@ -0,0 +1,10 @@
+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"
-}