@hawk.so/types 0.1.32-rc.2 → 0.1.32-rc.4

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

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

@@ -1,5 +1,4 @@
 import { EventData } from '../base/event/event';
-import { LogData } from '../base/log/log';
 import { PerformanceData } from '../base/performance/performance';
 import type { JavaScriptAddons, PhpAddons, NodeJSAddons, GoAddons, PythonAddons } from '../base/event/addons';
 /**
@@ -7,29 +6,22 @@ import type { JavaScriptAddons, PhpAddons, NodeJSAddons, GoAddons, PythonAddons
  */
 declare type ErrorsCatcherType = 'errors/javascript' | 'errors/php' | 'errors/nodejs' | 'errors/go' | 'errors/python';
 /**
- * Type that represents all supported Catcher message types for logs
- * @todo implement log catcher types
- */
-declare type LogsCatcherType = 'logs/javascript';
-/**
- * Type that represents all supported Catcher message types for metrics
- * @todo implement performance catcher types
+ * 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 | LogsCatcherType | MetricsCatcherType;
+export declare type CatcherMessageType = ErrorsCatcherType | MetricsCatcherType;
 /**
  * Type that represents the payload of a Catcher message based on its type
  */
-declare type CatcherMessagePayload<Type extends CatcherMessageType> = {
+export 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>;
-    'logs/javascript': LogData;
     'performance': PerformanceData;
 }[Type];
 /**

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.2",
+  "version": "0.1.32-rc.4",
   "description": "TypeScript definitions for Hawk",
   "types": "build/index.d.ts",
   "main": "build/index.js",

package/src/catchers/catcher-message.ts

@@ -22,12 +22,12 @@ type MetricsCatcherType = 'performance';
 /**
  * Union type that represents all supported Catcher message types
  */
-type CatcherMessageType = ErrorsCatcherType | MetricsCatcherType;
+export type CatcherMessageType = ErrorsCatcherType | MetricsCatcherType;
 
 /**
  * Type that represents the payload of a Catcher message based on its type
  */
-type CatcherMessagePayload<Type extends CatcherMessageType> = {
+export type CatcherMessagePayload<Type extends CatcherMessageType> = {
   'errors/javascript': EventData<JavaScriptAddons>;
   'errors/php': EventData<PhpAddons>;
   'errors/nodejs': EventData<NodeJSAddons>;