Merge pull request #14 from codex-team/upd/types-for-js-catcher

chore(catcher): types for js and php catchers added

Author: neSpecc

build/index.d.ts

@@ -5,6 +5,7 @@ export * from "./src/base/event/affectedUser";
 export * from "./src/base/event/backtraceFrame";
 export * from "./src/base/event/event";
 export * from "./src/base/event/sourceCodeLine";
+export * from "./src/base/event/addons";
 export * from "./src/dbScheme/businessOperation";
 export * from "./src/dbScheme/groupedEvent";
 export * from "./src/dbScheme/notificationsChannels";
@@ -21,3 +22,4 @@ export * from "./src/notifications/createProjectNotifications";
 export * from "./src/notifications/receiveTypes";
 export * from "./src/notifications/updateProjectNotifications";
 export * from "./src/notifications/userNotification";
+export * from './src/utils';

build/index.js

@@ -17,6 +17,7 @@ __exportStar(require("./src/base/event/affectedUser"), exports);
 __exportStar(require("./src/base/event/backtraceFrame"), exports);
 __exportStar(require("./src/base/event/event"), exports);
 __exportStar(require("./src/base/event/sourceCodeLine"), exports);
+__exportStar(require("./src/base/event/addons"), exports);
 __exportStar(require("./src/dbScheme/businessOperation"), exports);
 __exportStar(require("./src/dbScheme/groupedEvent"), exports);
 __exportStar(require("./src/dbScheme/notificationsChannels"), exports);
@@ -33,3 +34,4 @@ __exportStar(require("./src/notifications/createProjectNotifications"), exports)
 __exportStar(require("./src/notifications/receiveTypes"), exports);
 __exportStar(require("./src/notifications/updateProjectNotifications"), exports);
 __exportStar(require("./src/notifications/userNotification"), exports);
+__exportStar(require("./src/utils"), exports);

build/src/base/event/addons/index.d.ts

@@ -0,0 +1,7 @@
+import { JavaScriptAddons, WindowData, VueIntegrationAddons } from './javascript';
+import { PhpAddons } from './php';
+/**
+ * Union Type describing all catcher-specific additional data
+ */
+declare type EventAddons = JavaScriptAddons | PhpAddons;
+export { JavaScriptAddons, WindowData, VueIntegrationAddons, PhpAddons, EventAddons, };

build/src/base/event/addons/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

build/src/base/event/addons/javascript.d.ts

@@ -0,0 +1,68 @@
+import { Json } from '../../../utils';
+/**
+ * Additional data that can be sent by the JavaScript Catcher
+ */
+export interface JavaScriptAddons {
+    /**
+     * Information about the window
+     */
+    window: WindowData;
+    /**
+     * User Agent string
+     */
+    userAgent: string;
+    /**
+     * Where error happened
+     */
+    url: string;
+    /**
+     * Query parameters for the current URL
+     */
+    get?: Json;
+    /**
+     * Unparsed error data that can be send by enabling 'debug' option on the catcher side
+     */
+    RAW_EVENT_DATA?: Json;
+    /**
+     * Vue integration data
+     */
+    vue?: VueIntegrationAddons;
+}
+/**
+ * Information about the window
+ */
+export interface WindowData {
+    /**
+     * Window offset width in pixels
+     */
+    innerWidth: number;
+    /**
+     * Window offset height in pixels
+     */
+    innerHeight: number;
+}
+/**
+ * Additional data spoiled from Vue app
+ */
+export interface VueIntegrationAddons {
+    /**
+     * A Vue-specific error info, e.g. which lifecycle hook the error was found in.
+     */
+    lifecycle: string;
+    /**
+     * Component name where error occurred
+     */
+    component: string;
+    /**
+     * Component props
+     */
+    props?: Json;
+    /**
+     * Component local variables
+     */
+    data?: Json;
+    /**
+     * Component computed variables
+     */
+    computed?: Json;
+}

build/src/base/event/addons/javascript.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

build/src/base/event/addons/php.d.ts

@@ -0,0 +1,18 @@
+import { Json } from '../../../utils';
+/**
+ * This interface represents data that can be additionally collected by PHP Catcher
+ */
+export interface PhpAddons {
+    /**
+     * GET parameters
+     */
+    get?: Json;
+    /**
+     * POST parameters
+     */
+    post?: Json;
+    /**
+     * HTTP Headers
+     */
+    headers?: Json;
+}

build/src/base/event/addons/php.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

build/src/base/event/event.d.ts

@@ -1,50 +1,29 @@
-import { BacktraceFrame } from "./backtraceFrame";
-import { AffectedUser } from "./affectedUser";
-/**
- * Represents simple JSON-like document
- */
-declare type Dict = {
-    [key: string]: DictNode;
-};
-/**
- * Represents possible field values in Dict
- */
-declare type DictNode = string | number | boolean | Dict;
+import { BacktraceFrame } from './backtraceFrame';
+import { AffectedUser } from './affectedUser';
+import { EventAddons } from './addons';
+import { Json } from '../../utils';
 /**
  * Information about event
  * That object will be send as 'payload' to the Collector
  */
-export interface EventData {
+export interface EventData<CatcherAddons extends EventAddons> {
     /**
      * Event title
      */
     title: string;
     /**
-     * Occurrence time
-     * [!] Must be a Unix timestamp in seconds (example: 1567009247.576)
+     * Event type (severity level)
      */
-    timestamp: number;
+    type?: string;
     /**
      * Stack
      * From the latest call to the earliest
      */
     backtrace?: BacktraceFrame[];
-    /**
-     * GET parameters
-     */
-    get?: object;
-    /**
-     * POST parameters
-     */
-    post?: object;
-    /**
-     * Headers map
-     */
-    headers?: object;
     /**
      * Catcher-specific information
      */
-    addons?: Dict | string;
+    addons?: CatcherAddons | string;
     /**
      * Current release (aka version, revision) of an application
      */
@@ -56,26 +35,38 @@ export interface EventData {
     /**
      * Any other information collected and passed by user
      */
-    context?: Dict | string;
+    context?: EventContext | string;
+}
+/**
+ * Event accepted and processed by Collector.
+ * It sets the timestamp to the event payload.
+ */
+export interface EventDataAccepted<EventAddons> extends EventData<EventAddons> {
+    /**
+     * Occurrence time
+     * Unix timestamp in seconds (example: 1567009247.576)
+     * (Set by the Collector)
+     */
+    timestamp: number;
 }
 /**
  * Event data with decoded unsafe fields
  */
-export interface DecodedEventData extends EventData {
+export interface DecodedEventData<EventAddons> extends EventDataAccepted<EventAddons> {
     /**
      * Decoded context
      */
-    context?: Dict;
+    context?: EventContext;
     /**
      * Decoded addons
      */
-    addons?: Dict;
+    addons?: EventAddons;
 }
 /**
  * Event data with encoded unsafe fields
  *
  */
-export interface EncodedEventData extends EventData {
+export interface EncodedEventData extends EventDataAccepted<EventAddons> {
     /**
      * Encoded context
      */
@@ -85,4 +76,7 @@ export interface EncodedEventData extends EventData {
      */
     addons?: string;
 }
-export {};
+/**
+ * Context is any additional data sent by developer
+ */
+export declare type EventContext = Json;

build/src/dbScheme/groupedEvent.d.ts

@@ -1,6 +1,7 @@
 import { ObjectId } from "mongodb";
-import { DecodedEventData, EncodedEventData, EventData } from "../base/event/event";
+import { DecodedEventData, EncodedEventData, EventDataAccepted } from "../base/event/event";
 import { UserDBScheme } from "./user";
+import { EventAddons } from '../base/event/addons';
 /**
  * Event data after grouper-worker transformation to store it in database
  */
@@ -24,7 +25,7 @@ export interface GroupedEventDBScheme {
     /**
      * Event data
      */
-    payload: EventData;
+    payload: EventDataAccepted<EventAddons>;
     /**
      * How many users catch this error
      */
@@ -38,7 +39,7 @@ export interface GroupedEventDBScheme {
  * Grouped event with decoded event data
  */
 export interface DecodedGroupedEvent extends GroupedEventDBScheme {
-    payload: DecodedEventData;
+    payload: DecodedEventData<EventAddons>;
 }
 /**
  * Grouped event with encoded event data