@uptime.link/interfaces 2.0.0 → 2.0.3

package/dist_ts/00_commitinfo_data.js

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

package/dist_ts/data/checks.d.ts

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

package/dist_ts/data/checks.js

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

package/dist_ts/data/index.d.ts

@@ -1 +1,4 @@
+export * from './checks.js';
 export * from './incident.js';
+export * from './property.js';
+export * from './status.js';

package/dist_ts/data/index.js

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

package/dist_ts/data/property.d.ts

@@ -0,0 +1,6 @@
+export declare class IProperty {
+    name: string;
+    type: 'website' | 'app' | 'api' | 'other';
+    access: 'private' | 'public' | 'auth';
+    checkRefs: string[];
+}

package/dist_ts/data/property.js

@@ -0,0 +1,4 @@
+import '../ul-interfaces.plugins.js';
+export class IProperty {
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJvcGVydHkuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi90cy9kYXRhL3Byb3BlcnR5LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQXlCLDZCQUE2QixDQUFDO0FBRXZELE1BQU0sT0FBTyxTQUFTO0NBTXJCIn0=

package/dist_ts/data/status.d.ts

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

package/dist_ts/data/status.js

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

package/dist_ts/requests/index.d.ts

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

package/dist_ts/requests/index.js

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

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

@@ -1,63 +1,11 @@
+import { ICheck } from '../data/checks.js';
 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';
+export interface IRequest_CheckExchange extends plugins.typedRequestInterfaces.implementsTR<plugins.typedRequestInterfaces.ITypedRequest, IRequest_CheckExchange> {
+    method: 'check';
     request: {
-        intervalMs: number;
-        domain: string;
+        check: ICheck;
     };
     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[];
+        check: ICheck;
     };
 }

package/dist_ts/requests/requests.checks.js

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

package/dist_ts/requests/requests.status.d.ts

@@ -0,0 +1,11 @@
+import * as plugins from '../ul-interfaces.plugins.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;
+    };
+}

package/dist_ts/requests/requests.status.js

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

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

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

package/dist_ts/ul-interfaces.plugins.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uptime.link/interfaces",
-  "version": "2.0.0",
+  "version": "2.0.3",
   "private": false,
   "description": "TypeScript interface for the uptime.link API and modules",
   "main": "dist_ts/index.js",
@@ -20,7 +20,8 @@
     "@types/node": "^18.0.5"
   },
   "dependencies": {
-    "@apiglobal/typedrequest-interfaces": "^1.0.15"
+    "@apiglobal/typedrequest-interfaces": "^1.0.15",
+    "@tsclass/tsclass": "^4.0.17"
   },
   "files": [
     "ts/**/*",

package/ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@uptime.link/interfaces',
-  version: '2.0.0',
+  version: '2.0.3',
   description: 'TypeScript interface for the uptime.link API and modules'
 }

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

package/ts/data/index.ts

@@ -1 +1,4 @@
+export * from './checks.js';
 export * from './incident.js';
+export * from './property.js';
+export * from './status.js';

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

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

package/ts/requests/index.ts

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

package/ts/requests/requests.checks.ts

@@ -1,79 +1,16 @@
+import { ICheck } from '../data/checks.js';
 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
+export interface IRequest_CheckExchange
   extends plugins.typedRequestInterfaces.implementsTR<
     plugins.typedRequestInterfaces.ITypedRequest,
-    IRequest_PageCheck_Function
+    IRequest_CheckExchange
   > {
-  method: 'function';
+  method: 'check';
   request: {
-    intervalMs: number;
-    domain: string;
-    functionDef: string;
+    check: ICheck;
   };
   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[];
-  };
+    check: ICheck;
+  }
 }

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

package/ts/ul-interfaces.plugins.ts

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