@hawk.so/types 0.1.32-rc.1 → 0.1.32-rc.3

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

@@ -3,10 +3,10 @@ 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
+ * Information about event (Payload of the event)
+ * That object will be sent as 'payload' from the Collector to the workers
  */
-export interface EventData<CatcherAddons extends EventAddons> {
+export interface EventData<Addons extends EventAddons> {
     /**
      * Event title
      */
@@ -23,7 +23,7 @@ export interface EventData<CatcherAddons extends EventAddons> {
     /**
      * Catcher-specific information
      */
-    addons?: CatcherAddons | string;
+    addons?: Addons;
     /**
      * Current release (aka version, revision) of an application
      */
@@ -41,36 +41,29 @@ export interface EventData<CatcherAddons extends EventAddons> {
      */
     catcherVersion?: string;
 }
-/**
- * Event accepted and processed by Collector.
- * It sets the timestamp to the event payload.
- */
-export interface EventDataAccepted<EventAddons> extends EventData<EventAddons> {
-}
 /**
  * Event data with decoded unsafe fields
  */
-export interface DecodedEventData<EventAddons> extends EventDataAccepted<EventAddons> {
+export interface DecodedEventData<Addons extends EventAddons> extends EventData<Addons> {
     /**
-     * Decoded context
+     * Json parsed context string
      */
     context?: EventContext;
     /**
-     * Decoded addons
+     * Json parsed addons string
      */
-    addons?: EventAddons;
+    addons?: Addons;
 }
 /**
  * Event data with encoded unsafe fields
- *
  */
-export interface EncodedEventData extends EventDataAccepted<EventAddons> {
+export interface EncodedEventData extends EventData<EventAddons> {
     /**
-     * Encoded context
+     * Stringified context object
      */
     context?: string;
     /**
-     * Encoded addons
+     * Stringified addons object
      */
     addons?: string;
 }

package/build/src/base/log/log.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Interface representing the structure of log CatcherMessage payload.
+ * This interface is for payload of the CatcherMessages with CatcherType 'logs/*'.
+ */
+export interface LogData {
+}

package/build/src/base/log/log.js

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

package/build/src/base/performance/performance.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Interface representing the structure of performance CatcherMessage payload.
+ * This interface is for payload of the CatcherMessages with CatcherType 'performance'.
+ */
+export interface PerformanceData {
+}

package/build/src/base/performance/performance.js

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

package/build/src/catchers/catcher-message.d.ts

@@ -1,9 +1,34 @@
-import { EventData } from "../base/event/event";
-import { EventAddons } from "../base/event/addons";
+import { EventData } from '../base/event/event';
+import { PerformanceData } from '../base/performance/performance';
+import type { JavaScriptAddons, PhpAddons, NodeJSAddons, GoAddons, PythonAddons } from '../base/event/addons';
 /**
- * Structure describing a message sending by Catcher
+ * Type that represents all supported Catcher message types for events
  */
-export default interface CatcherMessage<CatcherAddons extends EventAddons> {
+declare type ErrorsCatcherType = 'errors/javascript' | 'errors/php' | 'errors/nodejs' | 'errors/go' | 'errors/python';
+/**
+ * Type that represents all supported Catcher message types for performance
+ */
+declare type MetricsCatcherType = 'performance';
+/**
+ * Union type that represents all supported Catcher message types
+ */
+declare type CatcherMessageType = ErrorsCatcherType | MetricsCatcherType;
+/**
+ * Type that represents the payload of a Catcher message based on its type
+ */
+declare type CatcherMessagePayload<Type extends CatcherMessageType> = {
+    'errors/javascript': EventData<JavaScriptAddons>;
+    'errors/php': EventData<PhpAddons>;
+    'errors/nodejs': EventData<NodeJSAddons>;
+    'errors/go': EventData<GoAddons>;
+    'errors/python': EventData<PythonAddons>;
+    'performance': PerformanceData;
+}[Type];
+/**
+ * Interface that represents a message sent by a Catcher
+ * It calculates the type of the payload based on the Catcher type
+ */
+export interface CatcherMessage<Type extends CatcherMessageType> {
     /**
      * User project's Integration Token
      */
@@ -11,9 +36,25 @@ export default interface CatcherMessage<CatcherAddons extends EventAddons> {
     /**
      * Hawk Catcher name
      */
-    catcherType: string;
+    catcherType: Type;
     /**
      * All information about the event
      */
-    payload: EventData<CatcherAddons>;
+    payload: CatcherMessagePayload<Type>;
 }
+/**
+ * Type that represents a Catcher message accepted by the collector
+ * It omits the token field and adds projectId and timestamp
+ */
+export declare type CatcherMessageAccepted<Type extends CatcherMessageType> = Omit<CatcherMessage<Type>, 'token'> & {
+    /**
+     * Id of the project that sent the message
+     */
+    projectId: string;
+    /**
+     * Timestamp of when the message was accepted by the collector
+     * This is the current time in milliseconds since the Unix epoch
+     */
+    timestamp: number;
+};
+export {};

package/build/src/dbScheme/groupedEvent.d.ts

@@ -1,5 +1,5 @@
 import { ObjectId } from "mongodb";
-import { DecodedEventData, EncodedEventData, EventDataAccepted } from "../base/event/event";
+import { DecodedEventData, EncodedEventData, EventData } from "../base/event/event";
 import { UserDBScheme } from "./user";
 import { EventAddons } from '../base/event/addons';
 /**
@@ -25,7 +25,7 @@ export interface GroupedEventDBScheme {
     /**
      * Event data
      */
-    payload: EventDataAccepted<EventAddons>;
+    payload: EventData<EventAddons>;
     /**
      * How many users catch this error
      */
@@ -37,7 +37,7 @@ export interface GroupedEventDBScheme {
     /**
      * Occurrence time
      * Unix timestamp in seconds (example: 1567009247.576)
-     * (Set by the Collector)
+     * (created by the Collector)
      */
     timestamp: number;
 }

package/build/src/dbScheme/repetition.d.ts

@@ -1,5 +1,5 @@
 import { ObjectId } from "mongodb";
-import { DecodedEventData, EncodedEventData, EventDataAccepted } from '../base/event/event';
+import { DecodedEventData, EncodedEventData, EventData } from '../base/event/event';
 import { EventAddons } from '../base/event/addons';
 export interface RepetitionDBScheme {
     /**
@@ -12,10 +12,10 @@ export interface RepetitionDBScheme {
     groupHash: string;
     /**
      * @deprecated, use delta instead
-     * And any of EventDataAccepted field with diff
+     * And any of EventData field with diff
      * except fields that used in groupHash
      */
-    payload?: EventDataAccepted<EventAddons>;
+    payload?: EventData<EventAddons>;
     /**
      * Delta between original event and repetition
      */
@@ -23,7 +23,7 @@ export interface RepetitionDBScheme {
     /**
      * Occurrence time
      * Unix timestamp in seconds (example: 1567009247.576)
-     * (Set by the Collector)
+     * (created by the Collector)
      */
     timestamp: number;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hawk.so/types",
-  "version": "0.1.32-rc.1",
+  "version": "0.1.32-rc.3",
   "description": "TypeScript definitions for Hawk",
   "types": "build/index.d.ts",
   "main": "build/index.js",

package/src/base/event/event.ts

@@ -4,10 +4,10 @@ import { EventAddons } from './addons';
 import { Json } from '../../utils';
 
 /**
- * Information about event
- * That object will be send as 'payload' to the Collector
+ * Information about event (Payload of the event)
+ * That object will be sent as 'payload' from the Collector to the workers
  */
-export interface EventData<CatcherAddons extends EventAddons> {
+export interface EventData<Addons extends EventAddons> {
     /**
      * Event title
      */
@@ -27,7 +27,7 @@ export interface EventData<CatcherAddons extends EventAddons> {
     /**
      * Catcher-specific information
      */
-    addons?: CatcherAddons | string;
+    addons?: Addons;
 
     /**
      * Current release (aka version, revision) of an application
@@ -50,40 +50,32 @@ export interface EventData<CatcherAddons extends EventAddons> {
     catcherVersion?: string;
 }
 
-/**
- * Event accepted and processed by Collector.
- * It sets the timestamp to the event payload.
- */
-export interface EventDataAccepted<EventAddons> extends EventData<EventAddons> {}
-
-
 /**
  * Event data with decoded unsafe fields
  */
-export interface DecodedEventData<EventAddons> extends EventDataAccepted<EventAddons> {
+export interface DecodedEventData<Addons extends EventAddons> extends EventData<Addons> {
     /**
-     * Decoded context
+     * Json parsed context string
      */
     context?: EventContext;
 
     /**
-     * Decoded addons
+     * Json parsed addons string
      */
-    addons?: EventAddons;
+    addons?: Addons;
 }
 
 /**
  * Event data with encoded unsafe fields
- *
  */
-export interface EncodedEventData extends EventDataAccepted<EventAddons> {
+export interface EncodedEventData extends EventData<EventAddons> {
     /**
-     * Encoded context
+     * Stringified context object
      */
     context?: string;
 
     /**
-     * Encoded addons
+     * Stringified addons object
      */
     addons?: string;
 }

package/src/base/performance/performance.ts

@@ -0,0 +1,5 @@
+/**
+ * Interface representing the structure of performance CatcherMessage payload.
+ * This interface is for payload of the CatcherMessages with CatcherType 'performance'.
+ */
+export interface PerformanceData {}

package/src/catchers/catcher-message.ts

@@ -1,10 +1,46 @@
-import { EventData } from "../base/event/event";
-import { EventAddons } from "../base/event/addons";
+import { EventData } from '../base/event/event';
+import { PerformanceData } from '../base/performance/performance';
+
+import type { 
+  JavaScriptAddons, 
+  PhpAddons,
+  NodeJSAddons,
+  GoAddons,
+  PythonAddons
+} from '../base/event/addons';
+
+/**
+ * Type that represents all supported Catcher message types for events
+ */
+type ErrorsCatcherType = 'errors/javascript' | 'errors/php' | 'errors/nodejs' | 'errors/go' | 'errors/python';
 
 /**
- * Structure describing a message sending by Catcher
+ * Type that represents all supported Catcher message types for performance
  */
-export default interface CatcherMessage<CatcherAddons extends EventAddons> {
+type MetricsCatcherType = 'performance';
+
+/**
+ * Union type that represents all supported Catcher message types
+ */
+type CatcherMessageType = ErrorsCatcherType | MetricsCatcherType;
+
+/**
+ * Type that represents the payload of a Catcher message based on its type
+ */
+type CatcherMessagePayload<Type extends CatcherMessageType> = {
+  'errors/javascript': EventData<JavaScriptAddons>;
+  'errors/php': EventData<PhpAddons>;
+  'errors/nodejs': EventData<NodeJSAddons>;
+  'errors/go': EventData<GoAddons>;
+  'errors/python': EventData<PythonAddons>;
+  'performance': PerformanceData;
+}[Type];
+
+/**
+ * Interface that represents a message sent by a Catcher
+ * It calculates the type of the payload based on the Catcher type
+ */
+export interface CatcherMessage<Type extends CatcherMessageType> {
   /**
    * User project's Integration Token
    */
@@ -13,10 +49,27 @@ export default interface CatcherMessage<CatcherAddons extends EventAddons> {
   /**
    * Hawk Catcher name
    */
-  catcherType: string;
+  catcherType: Type;
 
   /**
    * All information about the event
    */
-  payload: EventData<CatcherAddons>;
+  payload: CatcherMessagePayload<Type>;
 }
+
+/**
+ * Type that represents a Catcher message accepted by the collector
+ * It omits the token field and adds projectId and timestamp
+ */
+export type CatcherMessageAccepted<Type extends CatcherMessageType> = Omit<CatcherMessage<Type>, 'token'> & {
+  /**
+   * Id of the project that sent the message
+   */
+  projectId: string;
+
+  /**
+   * Timestamp of when the message was accepted by the collector
+   * This is the current time in milliseconds since the Unix epoch
+   */
+  timestamp: number;
+};

package/src/dbScheme/groupedEvent.ts

@@ -1,5 +1,5 @@
 import { ObjectId } from "mongodb";
-import { DecodedEventData, EncodedEventData, EventDataAccepted } from "../base/event/event";
+import { DecodedEventData, EncodedEventData, EventData } from "../base/event/event";
 import { UserDBScheme } from "./user";
 import { EventAddons } from '../base/event/addons';
 
@@ -30,7 +30,7 @@ export interface GroupedEventDBScheme {
     /**
      * Event data
      */
-    payload: EventDataAccepted<EventAddons>;
+    payload: EventData<EventAddons>;
 
     /**
      * How many users catch this error
@@ -45,7 +45,7 @@ export interface GroupedEventDBScheme {
     /**
      * Occurrence time
      * Unix timestamp in seconds (example: 1567009247.576)
-     * (Set by the Collector)
+     * (created by the Collector)
      */
     timestamp: number;
 }

package/src/dbScheme/repetition.ts

@@ -1,5 +1,5 @@
 import { ObjectId } from "mongodb";
-import { DecodedEventData, EncodedEventData, EventDataAccepted } from '../base/event/event';
+import { DecodedEventData, EncodedEventData, EventData } from '../base/event/event';
 import { EventAddons } from '../base/event/addons';
 
 export interface RepetitionDBScheme {
@@ -15,10 +15,10 @@ export interface RepetitionDBScheme {
 
     /**
      * @deprecated, use delta instead
-     * And any of EventDataAccepted field with diff
+     * And any of EventData field with diff
      * except fields that used in groupHash
      */
-    payload?: EventDataAccepted<EventAddons>;
+    payload?: EventData<EventAddons>;
 
     /**
      * Delta between original event and repetition
@@ -28,7 +28,7 @@ export interface RepetitionDBScheme {
     /**
      * Occurrence time
      * Unix timestamp in seconds (example: 1567009247.576)
-     * (Set by the Collector)
+     * (created by the Collector)
      */
     timestamp: number;
 }