@uptime.link/interfaces 2.0.2 → 2.0.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. package/dist_ts/00_commitinfo_data.js +1 -1
  2. package/dist_ts/data/checkcollection.d.ts +9 -0
  3. package/dist_ts/data/checkcollection.js +4 -0
  4. package/dist_ts/data/checks/assumption.check.d.ts +22 -0
  5. package/dist_ts/data/checks/assumption.check.js +3 -0
  6. package/dist_ts/data/checks/function.check.d.ts +14 -0
  7. package/dist_ts/data/checks/function.check.js +2 -0
  8. package/dist_ts/data/checks/index.d.ts +11 -0
  9. package/dist_ts/data/checks/index.js +5 -0
  10. package/dist_ts/data/checks/pagerank.check.d.ts +18 -0
  11. package/dist_ts/data/checks/pagerank.check.js +3 -0
  12. package/dist_ts/data/checks/pwa.check.d.ts +17 -0
  13. package/dist_ts/data/checks/pwa.check.js +2 -0
  14. package/dist_ts/data/index.d.ts +2 -1
  15. package/dist_ts/data/index.js +3 -2
  16. package/dist_ts/data/property.d.ts +4 -2
  17. package/dist_ts/data/property.js +2 -2
  18. package/dist_ts/data/search.d.ts +20 -0
  19. package/dist_ts/data/search.js +2 -0
  20. package/dist_ts/requests/index.d.ts +3 -2
  21. package/dist_ts/requests/index.js +4 -3
  22. package/dist_ts/requests/requests.checks.d.ts +3 -3
  23. package/dist_ts/requests/requests.checks.js +2 -2
  24. package/dist_ts/status.d.ts +1 -1
  25. package/dist_ts/ul-interfaces.plugins.js +1 -1
  26. package/package.json +8 -7
  27. package/readme.md +2 -4
  28. package/ts/00_commitinfo_data.ts +1 -1
  29. package/ts/data/checkcollection.ts +13 -0
  30. package/ts/data/checks/assumption.check.ts +23 -0
  31. package/ts/data/checks/function.check.ts +15 -0
  32. package/ts/data/checks/index.ts +13 -0
  33. package/ts/data/checks/pagerank.check.ts +19 -0
  34. package/ts/data/checks/pwa.check.ts +16 -0
  35. package/ts/data/index.ts +2 -1
  36. package/ts/data/property.ts +5 -4
  37. package/ts/data/search.ts +21 -0
  38. package/ts/data/status.ts +3 -3
  39. package/ts/requests/index.ts +3 -3
  40. package/ts/requests/requests.checks.ts +4 -4
  41. package/ts/ul-interfaces.plugins.ts +1 -3
  42. package/dist_ts/data/checks.d.ts +0 -54
  43. package/dist_ts/data/checks.js +0 -2
  44. package/ts/data/checks.ts +0 -59
@@ -3,7 +3,7 @@
3
3
  */
4
4
  export const commitinfo = {
5
5
  name: '@uptime.link/interfaces',
6
- version: '2.0.2',
6
+ version: '2.0.7',
7
7
  description: 'TypeScript interface for the uptime.link API and modules'
8
8
  };
9
9
  //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiMDBfY29tbWl0aW5mb19kYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvMDBfY29tbWl0aW5mb19kYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOztHQUVHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHO0lBQ3hCLElBQUksRUFBRSx5QkFBeUI7SUFDL0IsT0FBTyxFQUFFLE9BQU87SUFDaEIsV0FBVyxFQUFFLDBEQUEwRDtDQUN4RSxDQUFBIn0=
@@ -0,0 +1,9 @@
1
+ import * as checks from './checks/index.js';
2
+ export interface ICheckCollection {
3
+ id: string;
4
+ intervalMs: number;
5
+ assumptionChecks?: Array<checks.IAssumptionCheck>;
6
+ functionChecks: Array<checks.IFunctionCheck>;
7
+ pwaChecks?: Array<checks.IPwaCheck>;
8
+ pageRankChecks: Array<checks.IPageRankCheck>;
9
+ }
@@ -0,0 +1,4 @@
1
+ import '../ul-interfaces.plugins.js';
2
+ import './search.js';
3
+ import './checks/index.js';
4
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2hlY2tjb2xsZWN0aW9uLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvZGF0YS9jaGVja2NvbGxlY3Rpb24udHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBeUIsNkJBQTZCLENBQUM7QUFDdkQsT0FBd0IsYUFBYSxDQUFDO0FBRXRDLE9BQXdCLG1CQUFtQixDQUFDIn0=
@@ -0,0 +1,22 @@
1
+ import * as plugins from '../../ul-interfaces.plugins.js';
2
+ import { TCheckResultStatus, TExecutionTiming } from './index.js';
3
+ export interface IAssumptionCheck {
4
+ inputData: {
5
+ domain: string;
6
+ title?: string;
7
+ statusCode?: string;
8
+ description?: string;
9
+ dnsRecords?: plugins.tsclass.network.IDnsRecord;
10
+ };
11
+ executionResults: Array<{
12
+ timing: TExecutionTiming;
13
+ status: TCheckResultStatus;
14
+ data: {
15
+ domain: string;
16
+ title?: string;
17
+ statusCode?: string;
18
+ description?: string;
19
+ dnsRecords: Array<plugins.tsclass.network.IDnsRecord>;
20
+ };
21
+ }>;
22
+ }
@@ -0,0 +1,3 @@
1
+ import '../../ul-interfaces.plugins.js';
2
+ import './index.js';
3
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXNzdW1wdGlvbi5jaGVjay5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3RzL2RhdGEvY2hlY2tzL2Fzc3VtcHRpb24uY2hlY2sudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBeUIsZ0NBQWdDLENBQUM7QUFDMUQsT0FBcUQsWUFBWSxDQUFDIn0=
@@ -0,0 +1,14 @@
1
+ import { TCheckResultStatus, TExecutionTiming } from './index.js';
2
+ export interface IFunctionCheck {
3
+ checkId: string;
4
+ inputData: {
5
+ domain: string;
6
+ functionDef: string;
7
+ };
8
+ executionResults: Array<{
9
+ timing: TExecutionTiming;
10
+ status: TCheckResultStatus;
11
+ data: any;
12
+ checkLog: string[];
13
+ }>;
14
+ }
@@ -0,0 +1,2 @@
1
+ import './index.js';
2
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZnVuY3Rpb24uY2hlY2suanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi90cy9kYXRhL2NoZWNrcy9mdW5jdGlvbi5jaGVjay50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFxRCxZQUFZLENBQUMifQ==
@@ -0,0 +1,11 @@
1
+ export type TCheckResultStatus = 'ok' | 'not ok' | 'timed out';
2
+ export interface TExecutionTiming {
3
+ plannedTime: number;
4
+ timeStarted: number;
5
+ timeEnded: number;
6
+ duration: number;
7
+ }
8
+ export * from './assumption.check.js';
9
+ export * from './function.check.js';
10
+ export * from './pagerank.check.js';
11
+ export * from './pwa.check.js';
@@ -0,0 +1,5 @@
1
+ export * from './assumption.check.js';
2
+ export * from './function.check.js';
3
+ export * from './pagerank.check.js';
4
+ export * from './pwa.check.js';
5
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi90cy9kYXRhL2NoZWNrcy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFTQSxjQUFjLHVCQUF1QixDQUFDO0FBQ3RDLGNBQWMscUJBQXFCLENBQUM7QUFDcEMsY0FBYyxxQkFBcUIsQ0FBQztBQUNwQyxjQUFjLGdCQUFnQixDQUFDIn0=
@@ -0,0 +1,18 @@
1
+ import * as search from '../search.js';
2
+ import { TCheckResultStatus, TExecutionTiming } from './index.js';
3
+ export interface IPageRankCheck {
4
+ inputData: {
5
+ subId: string;
6
+ domain: string;
7
+ searchTerm: string;
8
+ checkBing?: boolean;
9
+ checkGoogle?: boolean;
10
+ bingMinRank?: number;
11
+ googleMinRank?: number;
12
+ };
13
+ executionResults: Array<{
14
+ timing: TExecutionTiming;
15
+ status: TCheckResultStatus;
16
+ pageRankResult: search.IPageRankResult;
17
+ }>;
18
+ }
@@ -0,0 +1,3 @@
1
+ import '../search.js';
2
+ import './index.js';
3
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicGFnZXJhbmsuY2hlY2suanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi90cy9kYXRhL2NoZWNrcy9wYWdlcmFuay5jaGVjay50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUF3QixjQUFjLENBQUM7QUFDdkMsT0FBcUQsWUFBWSxDQUFDIn0=
@@ -0,0 +1,17 @@
1
+ import { TCheckResultStatus } from './index.js';
2
+ export interface IPwaCheck {
3
+ inputData: {
4
+ domain: string;
5
+ };
6
+ executionResults: Array<{
7
+ subId: string;
8
+ timeStarted: number;
9
+ timeEnded: number;
10
+ duration: number;
11
+ status: TCheckResultStatus;
12
+ data: {
13
+ lhr: any;
14
+ reports: any[];
15
+ };
16
+ }>;
17
+ }
@@ -0,0 +1,2 @@
1
+ import './index.js';
2
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHdhLmNoZWNrLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vdHMvZGF0YS9jaGVja3MvcHdhLmNoZWNrLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQW1DLFlBQVksQ0FBQyJ9
@@ -1,4 +1,5 @@
1
- export * from './checks.js';
1
+ export * from './checkcollection.js';
2
2
  export * from './incident.js';
3
3
  export * from './property.js';
4
+ export * from './search.js';
4
5
  export * from './status.js';
@@ -1,5 +1,6 @@
1
- export * from './checks.js';
1
+ export * from './checkcollection.js';
2
2
  export * from './incident.js';
3
3
  export * from './property.js';
4
+ export * from './search.js';
4
5
  export * from './status.js';
5
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90cy9kYXRhL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLGNBQWMsYUFBYSxDQUFDO0FBQzVCLGNBQWMsZUFBZSxDQUFDO0FBQzlCLGNBQWMsZUFBZSxDQUFDO0FBQzlCLGNBQWMsYUFBYSxDQUFDIn0=
6
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90cy9kYXRhL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLGNBQWMsc0JBQXNCLENBQUM7QUFDckMsY0FBYyxlQUFlLENBQUM7QUFDOUIsY0FBYyxlQUFlLENBQUM7QUFDOUIsY0FBYyxhQUFhLENBQUM7QUFDNUIsY0FBYyxhQUFhLENBQUMifQ==
@@ -1,6 +1,8 @@
1
- export declare class IProperty {
1
+ export declare class IUplinkProperty {
2
+ wgOrgIdRef: string;
3
+ wgPropertyIdRef: string;
2
4
  name: string;
3
5
  type: 'website' | 'app' | 'api' | 'other';
4
6
  access: 'private' | 'public' | 'auth';
5
- checkRefs: string[];
7
+ checkCollectionIdRefs: string[];
6
8
  }
@@ -1,4 +1,4 @@
1
1
  import '../ul-interfaces.plugins.js';
2
- export class IProperty {
2
+ export class IUplinkProperty {
3
3
  }
4
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJvcGVydHkuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90cy9kYXRhL3Byb3BlcnR5LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQXlCLDZCQUE2QixDQUFDO0FBRXZELE1BQU0sT0FBTyxTQUFTO0NBTXJCIn0=
4
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJvcGVydHkuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90cy9kYXRhL3Byb3BlcnR5LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQXlCLDZCQUE2QixDQUFDO0FBRXZELE1BQU0sT0FBTyxlQUFlO0NBTzNCIn0=
@@ -0,0 +1,20 @@
1
+ export interface ISearchResult {
2
+ searchTerm: string;
3
+ targetUrl: string;
4
+ title: string;
5
+ description: string;
6
+ rank: number;
7
+ }
8
+ /**
9
+ * special data returned by the PageRankCheck check class
10
+ */
11
+ export interface IPageRankResult {
12
+ googleRank: number;
13
+ googleBlocked: boolean;
14
+ bingRank: number;
15
+ bingBlocked: boolean;
16
+ searchResults: {
17
+ google: ISearchResult[];
18
+ bing: ISearchResult[];
19
+ };
20
+ }
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2VhcmNoLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvZGF0YS9zZWFyY2gudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiJ9
@@ -1,2 +1,3 @@
1
- import * as checkRequests from './requests.checks.js';
2
- export { checkRequests };
1
+ export * from './requests.checks.js';
2
+ export * from './requests.incidents.js';
3
+ export * from './requests.status.js';
@@ -1,3 +1,4 @@
1
- import * as checkRequests from './requests.checks.js';
2
- export { checkRequests };
3
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90cy9yZXF1ZXN0cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssYUFBYSxNQUFNLHNCQUFzQixDQUFDO0FBRXRELE9BQU8sRUFBRSxhQUFhLEVBQUUsQ0FBQyJ9
1
+ export * from './requests.checks.js';
2
+ export * from './requests.incidents.js';
3
+ export * from './requests.status.js';
4
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90cy9yZXF1ZXN0cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxjQUFjLHNCQUFzQixDQUFDO0FBQ3JDLGNBQWMseUJBQXlCLENBQUM7QUFDeEMsY0FBYyxzQkFBc0IsQ0FBQyJ9
@@ -1,11 +1,11 @@
1
- import { ICheck } from '../data/checks.js';
1
+ import { ICheckCollection } from '../data/checkcollection.js';
2
2
  import * as plugins from '../ul-interfaces.plugins.js';
3
3
  export interface IRequest_CheckExchange extends plugins.typedRequestInterfaces.implementsTR<plugins.typedRequestInterfaces.ITypedRequest, IRequest_CheckExchange> {
4
4
  method: 'check';
5
5
  request: {
6
- check: ICheck;
6
+ checkCollection: ICheckCollection;
7
7
  };
8
8
  response: {
9
- check: ICheck;
9
+ checkCollection: ICheckCollection;
10
10
  };
11
11
  }
@@ -1,3 +1,3 @@
1
- import '../data/checks.js';
1
+ import '../data/checkcollection.js';
2
2
  import '../ul-interfaces.plugins.js';
3
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVxdWVzdHMuY2hlY2tzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvcmVxdWVzdHMvcmVxdWVzdHMuY2hlY2tzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQXVCLG1CQUFtQixDQUFDO0FBQzNDLE9BQXlCLDZCQUE2QixDQUFDIn0=
3
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVxdWVzdHMuY2hlY2tzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvcmVxdWVzdHMvcmVxdWVzdHMuY2hlY2tzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQWlDLDRCQUE0QixDQUFDO0FBQzlELE9BQXlCLDZCQUE2QixDQUFDIn0=
@@ -1,4 +1,4 @@
1
- export declare type TServiceStatus = 'up' | 'down';
1
+ export type TServiceStatus = 'up' | 'down';
2
2
  export interface IHourlyStatus {
3
3
  states: {
4
4
  unixTimes: number;
@@ -3,4 +3,4 @@ export { typedRequestInterfaces };
3
3
  // tsclass scope
4
4
  import * as tsclass from '@tsclass/tsclass';
5
5
  export { tsclass };
6
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidWwtaW50ZXJmYWNlcy5wbHVnaW5zLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvdWwtaW50ZXJmYWNlcy5wbHVnaW5zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxzQkFBc0IsTUFBTSxvQ0FBb0MsQ0FBQztBQUU3RSxPQUFPLEVBQUUsc0JBQXNCLEVBQUUsQ0FBQztBQUVsQyxnQkFBZ0I7QUFDaEIsT0FBTyxLQUFLLE9BQU8sTUFBTSxrQkFBa0IsQ0FBQztBQUU1QyxPQUFPLEVBQ0wsT0FBTyxFQUNSLENBQUEifQ==
6
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidWwtaW50ZXJmYWNlcy5wbHVnaW5zLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvdWwtaW50ZXJmYWNlcy5wbHVnaW5zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sS0FBSyxzQkFBc0IsTUFBTSxvQ0FBb0MsQ0FBQztBQUU3RSxPQUFPLEVBQUUsc0JBQXNCLEVBQUUsQ0FBQztBQUVsQyxnQkFBZ0I7QUFDaEIsT0FBTyxLQUFLLE9BQU8sTUFBTSxrQkFBa0IsQ0FBQztBQUU1QyxPQUFPLEVBQUUsT0FBTyxFQUFFLENBQUMifQ==
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uptime.link/interfaces",
3
- "version": "2.0.2",
3
+ "version": "2.0.7",
4
4
  "private": false,
5
5
  "description": "TypeScript interface for the uptime.link API and modules",
6
6
  "main": "dist_ts/index.js",
@@ -14,14 +14,15 @@
14
14
  "buildDocs": "tsdoc"
15
15
  },
16
16
  "devDependencies": {
17
- "@gitzone/tsbuild": "^2.1.63",
18
- "@gitzone/tstest": "^1.0.71",
19
- "@pushrocks/tapbundle": "^5.0.3",
20
- "@types/node": "^18.0.5"
17
+ "@gitzone/tsbuild": "^2.1.65",
18
+ "@gitzone/tsrun": "^1.2.39",
19
+ "@gitzone/tstest": "^1.0.74",
20
+ "@pushrocks/tapbundle": "^5.0.4",
21
+ "@types/node": "^18.15.11"
21
22
  },
22
23
  "dependencies": {
23
- "@apiglobal/typedrequest-interfaces": "^1.0.15",
24
- "@tsclass/tsclass": "^4.0.17"
24
+ "@apiglobal/typedrequest-interfaces": "^2.0.1",
25
+ "@tsclass/tsclass": "^4.0.34"
25
26
  },
26
27
  "files": [
27
28
  "ts/**/*",
package/readme.md CHANGED
@@ -21,7 +21,6 @@ Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](htt
21
21
  PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@uptime.link/interfaces)](https://lossless.cloud)
22
22
  PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@uptime.link/interfaces)](https://lossless.cloud)
23
23
  BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@uptime.link/interfaces)](https://lossless.cloud)
24
- 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)
25
24
 
26
25
  ## Usage
27
26
 
@@ -35,7 +34,6 @@ We are always happy for code contributions. If you are not the code contributing
35
34
 
36
35
  For further information read the linked docs at the top of this readme.
37
36
 
38
- > MIT licensed | **&copy;** [Lossless GmbH](https://lossless.gmbh)
37
+ ## Legal
38
+ > MIT licensed | **&copy;** [Task Venture Capital GmbH](https://task.vc)
39
39
  | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
40
-
41
- [![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)
@@ -3,6 +3,6 @@
3
3
  */
4
4
  export const commitinfo = {
5
5
  name: '@uptime.link/interfaces',
6
- version: '2.0.2',
6
+ version: '2.0.7',
7
7
  description: 'TypeScript interface for the uptime.link API and modules'
8
8
  }
@@ -0,0 +1,13 @@
1
+ import * as plugins from '../ul-interfaces.plugins.js';
2
+ import * as search from './search.js';
3
+
4
+ import * as checks from './checks/index.js';
5
+
6
+ export interface ICheckCollection {
7
+ id: string;
8
+ intervalMs: number;
9
+ assumptionChecks?: Array<checks.IAssumptionCheck>;
10
+ functionChecks: Array<checks.IFunctionCheck>;
11
+ pwaChecks?: Array<checks.IPwaCheck>;
12
+ pageRankChecks: Array<checks.IPageRankCheck>;
13
+ }
@@ -0,0 +1,23 @@
1
+ import * as plugins from '../../ul-interfaces.plugins.js';
2
+ import { TCheckResultStatus, TExecutionTiming } from './index.js';
3
+
4
+ export interface IAssumptionCheck {
5
+ inputData: {
6
+ domain: string;
7
+ title?: string;
8
+ statusCode?: string;
9
+ description?: string;
10
+ dnsRecords?: plugins.tsclass.network.IDnsRecord;
11
+ };
12
+ executionResults: Array<{
13
+ timing: TExecutionTiming;
14
+ status: TCheckResultStatus;
15
+ data: {
16
+ domain: string;
17
+ title?: string;
18
+ statusCode?: string;
19
+ description?: string;
20
+ dnsRecords: Array<plugins.tsclass.network.IDnsRecord>;
21
+ };
22
+ }>;
23
+ }
@@ -0,0 +1,15 @@
1
+ import { TCheckResultStatus, TExecutionTiming } from './index.js';
2
+
3
+ export interface IFunctionCheck {
4
+ checkId: string;
5
+ inputData: {
6
+ domain: string;
7
+ functionDef: string;
8
+ };
9
+ executionResults: Array<{
10
+ timing: TExecutionTiming;
11
+ status: TCheckResultStatus;
12
+ data: any;
13
+ checkLog: string[];
14
+ }>;
15
+ }
@@ -0,0 +1,13 @@
1
+ export type TCheckResultStatus = 'ok' | 'not ok' | 'timed out';
2
+
3
+ export interface TExecutionTiming {
4
+ plannedTime: number;
5
+ timeStarted: number;
6
+ timeEnded: number;
7
+ duration: number;
8
+ }
9
+
10
+ export * from './assumption.check.js';
11
+ export * from './function.check.js';
12
+ export * from './pagerank.check.js';
13
+ export * from './pwa.check.js';
@@ -0,0 +1,19 @@
1
+ import * as search from '../search.js';
2
+ import { TCheckResultStatus, TExecutionTiming } from './index.js';
3
+
4
+ export interface IPageRankCheck {
5
+ inputData: {
6
+ subId: string;
7
+ domain: string;
8
+ searchTerm: string;
9
+ checkBing?: boolean;
10
+ checkGoogle?: boolean;
11
+ bingMinRank?: number;
12
+ googleMinRank?: number;
13
+ };
14
+ executionResults: Array<{
15
+ timing: TExecutionTiming;
16
+ status: TCheckResultStatus;
17
+ pageRankResult: search.IPageRankResult;
18
+ }>;
19
+ }
@@ -0,0 +1,16 @@
1
+ import { TCheckResultStatus } from './index.js';
2
+
3
+ export interface IPwaCheck {
4
+ inputData: { domain: string };
5
+ executionResults: Array<{
6
+ subId: string;
7
+ timeStarted: number;
8
+ timeEnded: number;
9
+ duration: number;
10
+ status: TCheckResultStatus;
11
+ data: {
12
+ lhr: any;
13
+ reports: any[];
14
+ };
15
+ }>;
16
+ }
package/ts/data/index.ts CHANGED
@@ -1,4 +1,5 @@
1
- export * from './checks.js';
1
+ export * from './checkcollection.js';
2
2
  export * from './incident.js';
3
3
  export * from './property.js';
4
+ export * from './search.js';
4
5
  export * from './status.js';
@@ -1,9 +1,10 @@
1
1
  import * as plugins from '../ul-interfaces.plugins.js';
2
2
 
3
- export class IProperty {
3
+ export class IUplinkProperty {
4
+ wgOrgIdRef: string;
5
+ wgPropertyIdRef: string;
4
6
  name: string;
5
7
  type: 'website' | 'app' | 'api' | 'other';
6
8
  access: 'private' | 'public' | 'auth';
7
- checkRefs: string[];
8
-
9
- }
9
+ checkCollectionIdRefs: string[];
10
+ }
@@ -0,0 +1,21 @@
1
+ export interface ISearchResult {
2
+ searchTerm: string;
3
+ targetUrl: string;
4
+ title: string;
5
+ description: string;
6
+ rank: number;
7
+ }
8
+
9
+ /**
10
+ * special data returned by the PageRankCheck check class
11
+ */
12
+ export interface IPageRankResult {
13
+ googleRank: number;
14
+ googleBlocked: boolean;
15
+ bingRank: number;
16
+ bingBlocked: boolean;
17
+ searchResults: {
18
+ google: ISearchResult[];
19
+ bing: ISearchResult[];
20
+ };
21
+ }
package/ts/data/status.ts CHANGED
@@ -1,12 +1,12 @@
1
1
  import * as plugins from '../ul-interfaces.plugins.js';
2
2
 
3
3
  export interface IStatus {
4
- last90days: IDailyStatus[];
4
+ last90days: IDailyStatus[];
5
5
  }
6
6
 
7
7
  export interface IDailyStatus {
8
- timezone: 'UTC',
8
+ timezone: 'UTC';
9
9
  date: plugins.tsclass.general.IDate;
10
10
  overallStatus: 'ok' | 'reduced' | 'outage';
11
11
  incidentRefs: string[];
12
- }
12
+ }
@@ -1,3 +1,3 @@
1
- import * as checkRequests from './requests.checks.js';
2
-
3
- export { checkRequests };
1
+ export * from './requests.checks.js';
2
+ export * from './requests.incidents.js';
3
+ export * from './requests.status.js';
@@ -1,4 +1,4 @@
1
- import { ICheck } from '../data/checks.js';
1
+ import { ICheckCollection } from '../data/checkcollection.js';
2
2
  import * as plugins from '../ul-interfaces.plugins.js';
3
3
 
4
4
  export interface IRequest_CheckExchange
@@ -8,9 +8,9 @@ export interface IRequest_CheckExchange
8
8
  > {
9
9
  method: 'check';
10
10
  request: {
11
- check: ICheck;
11
+ checkCollection: ICheckCollection;
12
12
  };
13
13
  response: {
14
- check: ICheck;
15
- }
14
+ checkCollection: ICheckCollection;
15
+ };
16
16
  }
@@ -5,6 +5,4 @@ export { typedRequestInterfaces };
5
5
  // tsclass scope
6
6
  import * as tsclass from '@tsclass/tsclass';
7
7
 
8
- export {
9
- tsclass
10
- }
8
+ export { tsclass };
@@ -1,54 +0,0 @@
1
- export declare type TCheckResultStatus = 'ok' | 'not ok' | 'timed out';
2
- export interface ICheck {
3
- type: 'pwa' | 'function' | 'assumption';
4
- intervalMs: number;
5
- pwaData?: {
6
- domain: string;
7
- };
8
- functionData: {
9
- domain: string;
10
- functionDef: string;
11
- };
12
- assumptionData?: {
13
- domain: string;
14
- title?: string;
15
- statusCode?: string;
16
- description?: string;
17
- dnsRecordMx?: string;
18
- dnsRecordTxt?: string;
19
- };
20
- checkResults: Array<{
21
- pwaResult?: {
22
- timeStarted: number;
23
- timeEnded: number;
24
- duration: number;
25
- status: TCheckResultStatus;
26
- data: {
27
- lhr: any;
28
- reports: any[];
29
- };
30
- };
31
- functionResult?: {
32
- timeStarted: number;
33
- timeEnded: number;
34
- duration: number;
35
- status: TCheckResultStatus;
36
- data: any;
37
- };
38
- assumptionResult: {
39
- timeStarted: number;
40
- timeEnded: number;
41
- duration: number;
42
- status: TCheckResultStatus;
43
- data: {
44
- domain: string;
45
- title?: string;
46
- statusCode?: string;
47
- description?: string;
48
- dnsRecordMx?: string;
49
- dnsRecordTxt?: string;
50
- };
51
- };
52
- checkLog: string[];
53
- }>;
54
- }
@@ -1,2 +0,0 @@
1
- import '../ul-interfaces.plugins.js';
2
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2hlY2tzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vdHMvZGF0YS9jaGVja3MudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBeUIsNkJBQTZCLENBQUMifQ==
package/ts/data/checks.ts DELETED
@@ -1,59 +0,0 @@
1
- import * as plugins from '../ul-interfaces.plugins.js';
2
-
3
- export type TCheckResultStatus = 'ok' | 'not ok' | 'timed out';
4
-
5
- export interface ICheck {
6
- type: 'pwa' | 'function' | 'assumption';
7
- intervalMs: number;
8
- pwaData?: {
9
- domain: string;
10
- };
11
- functionData: {
12
- domain: string;
13
- functionDef: string;
14
- };
15
- assumptionData?: {
16
- domain: string;
17
- title?: string;
18
- statusCode?: string;
19
- description?: string;
20
- dnsRecordMx?: string;
21
- dnsRecordTxt?: string;
22
- };
23
-
24
- checkResults: Array<{
25
- pwaResult?: {
26
- timeStarted: number;
27
- timeEnded: number;
28
- duration: number;
29
- status: TCheckResultStatus;
30
- data: {
31
- lhr: any;
32
- reports: any[];
33
- };
34
- };
35
- functionResult?: {
36
- timeStarted: number;
37
- timeEnded: number;
38
- duration: number;
39
- status: TCheckResultStatus;
40
- data: any;
41
-
42
- };
43
- assumptionResult: {
44
- timeStarted: number;
45
- timeEnded: number;
46
- duration: number;
47
- status: TCheckResultStatus;
48
- data: {
49
- domain: string;
50
- title?: string;
51
- statusCode?: string;
52
- description?: string;
53
- dnsRecordMx?: string;
54
- dnsRecordTxt?: string;
55
- };
56
- };
57
- checkLog: string[];
58
- }>;
59
- }