@uptime.link/interfaces 2.0.0

package/dist_ts/00_commitinfo_data.d.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export declare const commitinfo: {
+    name: string;
+    version: string;
+    description: string;
+};

package/dist_ts/00_commitinfo_data.js

@@ -0,0 +1,9 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+    name: '@uptime.link/interfaces',
+    version: '2.0.0',
+    description: 'TypeScript interface for the uptime.link API and modules'
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiMDBfY29tbWl0aW5mb19kYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvMDBfY29tbWl0aW5mb19kYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOztHQUVHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHO0lBQ3hCLElBQUksRUFBRSx5QkFBeUI7SUFDL0IsT0FBTyxFQUFFLE9BQU87SUFDaEIsV0FBVyxFQUFFLDBEQUEwRDtDQUN4RSxDQUFBIn0=

package/dist_ts/data/incident.d.ts

@@ -0,0 +1,18 @@
+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;
+    };
+}

package/dist_ts/data/incident.js

@@ -0,0 +1,2 @@
+import '../ul-interfaces.plugins.js';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5jaWRlbnQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90cy9kYXRhL2luY2lkZW50LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQXlCLDZCQUE2QixDQUFDIn0=

package/dist_ts/data/index.d.ts

@@ -0,0 +1 @@
+export * from './incident.js';

package/dist_ts/data/index.js

@@ -0,0 +1,2 @@
+export * from './incident.js';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90cy9kYXRhL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLGNBQWMsZUFBZSxDQUFDIn0=

package/dist_ts/index.d.ts

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

package/dist_ts/index.js

@@ -0,0 +1,4 @@
+import * as requests from './requests/index.js';
+import * as data from './data/index.js';
+export { requests, data };
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssUUFBUSxNQUFNLHFCQUFxQixDQUFDO0FBQ2hELE9BQU8sS0FBSyxJQUFJLE1BQU0saUJBQWlCLENBQUM7QUFFeEMsT0FBTyxFQUFFLFFBQVEsRUFBRSxJQUFJLEVBQUUsQ0FBQyJ9

package/dist_ts/requests/index.d.ts

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

package/dist_ts/requests/index.js

@@ -0,0 +1,3 @@
+import * as checkRequests from './requests.checks.js';
+export { checkRequests };
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90cy9yZXF1ZXN0cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssYUFBYSxNQUFNLHNCQUFzQixDQUFDO0FBRXRELE9BQU8sRUFBRSxhQUFhLEVBQUUsQ0FBQyJ9

package/dist_ts/requests/requests.checks.d.ts

@@ -0,0 +1,63 @@
+import * as plugins from '../ul-interfaces.plugins.js';
+export declare type TCheckResultStatus = 'ok' | 'not ok' | 'timed out';
+export interface IRequest_PageCheck_PWA extends plugins.typedRequestInterfaces.implementsTR<plugins.typedRequestInterfaces.ITypedRequest, 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 extends plugins.typedRequestInterfaces.implementsTR<plugins.typedRequestInterfaces.ITypedRequest, 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 extends plugins.typedRequestInterfaces.implementsTR<plugins.typedRequestInterfaces.ITypedRequest, 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[];
+    };
+}

package/dist_ts/requests/requests.checks.js

@@ -0,0 +1,2 @@
+import '../ul-interfaces.plugins.js';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVxdWVzdHMuY2hlY2tzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvcmVxdWVzdHMvcmVxdWVzdHMuY2hlY2tzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQXlCLDZCQUE2QixDQUFDIn0=

package/dist_ts/requests/requests.incidents.d.ts

@@ -0,0 +1,12 @@
+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[];
+    };
+}

package/dist_ts/requests/requests.incidents.js

@@ -0,0 +1,3 @@
+import '../ul-interfaces.plugins.js';
+import '../data/index.js';
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVxdWVzdHMuaW5jaWRlbnRzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvcmVxdWVzdHMvcmVxdWVzdHMuaW5jaWRlbnRzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQXlCLDZCQUE2QixDQUFDO0FBQ3ZELE9BQXNCLGtCQUFrQixDQUFDIn0=

package/dist_ts/status.d.ts

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

package/dist_ts/status.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic3RhdHVzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc3RhdHVzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIifQ==

package/dist_ts/ul-interfaces.plugins.d.ts

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

package/dist_ts/ul-interfaces.plugins.js

@@ -0,0 +1,3 @@
+import * as typedRequestInterfaces from '@apiglobal/typedrequest-interfaces';
+export { typedRequestInterfaces };
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidWwtaW50ZXJmYWNlcy5wbHVnaW5zLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvdWwtaW50ZXJmYWNlcy5wbHVnaW5zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxzQkFBc0IsTUFBTSxvQ0FBb0MsQ0FBQztBQUU3RSxPQUFPLEVBQUUsc0JBQXNCLEVBQUUsQ0FBQyJ9

package/license

@@ -0,0 +1,19 @@
+Copyright (c) 2019 Lossless GmbH (hello@lossless.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/npmextra.json

@@ -0,0 +1,18 @@
+{
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "uptime.link",
+      "gitrepo": "interfaces",
+      "description": "TypeScript interface for the uptime.link API and modules",
+      "npmPackagename": "@uptime.link/interfaces",
+      "license": "MIT",
+      "projectDomain": "uptime.link"
+    }
+  },
+  "npmci": {
+    "npmGlobalTools": [],
+    "npmAccessLevel": "public"
+  }
+}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@uptime.link/interfaces",
+  "version": "2.0.0",
+  "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 --web)",
+    "buildDocs": "tsdoc"
+  },
+  "devDependencies": {
+    "@gitzone/tsbuild": "^2.1.63",
+    "@gitzone/tstest": "^1.0.71",
+    "@pushrocks/tapbundle": "^5.0.3",
+    "@types/node": "^18.0.5"
+  },
+  "dependencies": {
+    "@apiglobal/typedrequest-interfaces": "^1.0.15"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
+  ]
+}

package/readme.md

@@ -0,0 +1,41 @@
+# @uptime.link/interfaces
+TypeScript interface for the uptime.link API and modules
+
+## Availabililty and Links
+* [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 | [![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)
+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
+
+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)
+| 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)

package/ts/00_commitinfo_data.ts

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

package/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;
+  };
+}

package/ts/data/index.ts

@@ -0,0 +1 @@
+export * from './incident.js';

package/ts/index.ts

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

package/ts/requests/index.ts

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

package/ts/requests/requests.checks.ts

@@ -0,0 +1,79 @@
+import * as plugins from '../ul-interfaces.plugins.js';
+
+export type TCheckResultStatus = 'ok' | 'not ok' | 'timed out';
+
+export interface IRequest_PageCheck_PWA
+  extends plugins.typedRequestInterfaces.implementsTR<
+    plugins.typedRequestInterfaces.ITypedRequest,
+    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
+  extends plugins.typedRequestInterfaces.implementsTR<
+    plugins.typedRequestInterfaces.ITypedRequest,
+    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
+  extends plugins.typedRequestInterfaces.implementsTR<
+    plugins.typedRequestInterfaces.ITypedRequest,
+    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[];
+  };
+}

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

package/ts/status.ts

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

package/ts/ul-interfaces.plugins.ts

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