@hawk.so/types 0.2.0 → 0.4.0

package/src/base/event/event.ts

@@ -1,89 +1,83 @@
-import { BacktraceFrame } from './backtraceFrame';
-import { AffectedUser } from './affectedUser';
-import { EventAddons } from './addons';
-import { Breadcrumb } from './breadcrumb';
-import { Json } from '../../utils';
+import type { BacktraceFrame } from './backtraceFrame.ts';
+import type { AffectedUser } from './affectedUser.ts';
+import type { EventAddons } from './addons/index.ts';
+import type { Json } from '../../utils/index.ts';
 
 /**
  * Information about event (Payload of the event)
  * That object will be sent as 'payload' from the Collector to the workers
  */
 export interface EventData<Addons extends EventAddons> {
-    /**
-     * Event title
-     */
-    title: string;
+  /**
+   * Event title
+   */
+  title: string;
 
-    /**
-     * Event type (severity level)
-     */
-    type?: string;
+  /**
+   * Event type (severity level)
+   */
+  type?: string;
 
-    /**
-     * Stack
-     * From the latest call to the earliest
-     */
-    backtrace?: BacktraceFrame[];
+  /**
+   * Stack
+   * From the latest call to the earliest
+   */
+  backtrace?: BacktraceFrame[];
 
-    /**
-     * Catcher-specific information
-     */
-    addons?: Addons;
+  /**
+   * Catcher-specific information
+   */
+  addons?: Addons;
 
-    /**
-     * Current release (aka version, revision) of an application
-     */
-    release?: string;
+  /**
+   * Current release (aka version, revision) of an application
+   */
+  release?: string;
 
-    /**
-     * Breadcrumbs - chronological trail of events before the error
-     */
-    breadcrumbs?: Breadcrumb[];
+  /**
+   * Current authenticated user
+   */
+  user?: AffectedUser;
 
-    /**
-     * Current authenticated user
-     */
-    user?: AffectedUser;
+  /**
+   * Any other information collected and passed by user
+   */
+  context?: EventContext | string;
 
-    /**
-     * Any other information collected and passed by user
-     */
-    context?: EventContext | string;
-
-    /**
-     * Catcher version
-     */
-    catcherVersion?: string;
+  /**
+   * Catcher version
+   */
+  catcherVersion?: string;
 }
 
 /**
  * Event data with decoded unsafe fields
  */
 export interface DecodedEventData<Addons extends EventAddons> extends EventData<Addons> {
-    /**
-     * Json parsed context string
-     */
-    context?: EventContext;
+  /**
+   * Json parsed context string
+   */
+  context?: EventContext;
 
-    /**
-     * Json parsed addons string
-     */
-    addons?: Addons;
+  /**
+   * Json parsed addons string
+   */
+  addons?: Addons;
 }
 
 /**
  * Event data with encoded unsafe fields
  */
 export interface EncodedEventData extends EventData<EventAddons> {
-    /**
-     * Stringified context object
-     */
-    context?: string;
+  /**
+   * Stringified context object
+   */
+  context?: string;
 
-    /**
-     * Stringified addons object
-     */
-    addons?: string;
+  /**
+   * Stringified addons object
+   */
+  addons?: string;
 }
 
 /**

package/src/base/event/sourceCodeLine.ts

@@ -3,13 +3,13 @@
  * Used in event.payload.backtrace[].sourceCode
  */
 export interface SourceCodeLine {
-    /**
-     * Line number
-     */
-    line: number;
+  /**
+   * Line number
+   */
+  line: number;
 
-    /**
-     * Line content
-     */
-    content: string;
+  /**
+   * Line content
+   */
+  content: string;
 }

package/src/base/performance/performance.ts

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

package/src/catchers/catcher-message.ts

@@ -1,14 +1,14 @@
-import { DecodedEventData, EventData } from '../base/event/event';
-import { PerformanceData } from '../base/performance/performance';
+import type { DecodedEventData, EventData } from '../base/event/event.ts';
+import type { PerformanceData } from '../base/performance/performance.ts';
 
-import type { 
-  JavaScriptAddons, 
+import type {
+  JavaScriptAddons,
   PhpAddons,
   NodeJSAddons,
   GoAddons,
   PythonAddons,
-  DefaultAddons,
-} from '../base/event/addons';
+  DefaultAddons
+} from '../base/event/addons/index.ts';
 
 /**
  * Type that represents all supported Catcher message types for events
@@ -18,7 +18,7 @@ export type ErrorsCatcherType = 'errors/javascript'
   | 'errors/nodejs'
   | 'errors/go'
   | 'errors/python'
-  | 'errors/default'
+  | 'errors/default';
 
 /**
  * Type that represents all supported Catcher message types for performance
@@ -34,13 +34,34 @@ export type CatcherMessageType = ErrorsCatcherType | MetricsCatcherType;
  * Type that represents the payload of a Catcher message based on its type
  */
 export type CatcherMessagePayload<Type extends CatcherMessageType> = {
+  /**
+   * Addons that can be added to all errors except those which have a separate workers
+   */
   'errors/default': DecodedEventData<DefaultAddons>;
+  /**
+   * Added by JavaScript SDK
+   */
   'errors/javascript': DecodedEventData<JavaScriptAddons>;
+  /**
+   * Added by PHP SDK
+   */
   'errors/php': EventData<PhpAddons>;
+  /**
+   * Added by Node.js SDK
+   */
   'errors/nodejs': EventData<NodeJSAddons>;
+  /**
+   * Added by Go SDK
+   */
   'errors/go': EventData<GoAddons>;
+  /**
+   * Added by Python SDK
+   */
   'errors/python': EventData<PythonAddons>;
-  'performance': PerformanceData;
+  /**
+   * Performance monitoring data
+   */
+  performance: PerformanceData;
 }[Type];
 
 /**

package/src/dbScheme/businessOperation.ts

@@ -1,37 +1,37 @@
-import { ObjectId } from "mongodb";
-import { BusinessOperationStatus, BusinessOperationType, BusinessOperationPayloadType } from "../base/businessOperation/businessOperation";
+import type { ObjectId } from 'bson';
+import type { BusinessOperationStatus, BusinessOperationType, BusinessOperationPayloadType } from '../base/businessOperation/businessOperation.ts';
 
 /**
  * Structure represents a Business operation in DataBase
  */
 export interface BusinessOperationDBScheme<T extends BusinessOperationPayloadType = BusinessOperationPayloadType> {
-    /**
-     * Business operation ID
-     */
-    _id?: ObjectId;
+  /**
+   * Business operation ID
+   */
+  _id?: ObjectId;
 
-    /**
-     * Business operation Transaction ID
-     */
-    transactionId: string;
+  /**
+   * Business operation Transaction ID
+   */
+  transactionId: string;
 
-    /**
-     * Business operation type
-     */
-    type: BusinessOperationType;
+  /**
+   * Business operation type
+   */
+  type: BusinessOperationType;
 
-    /**
-     * Business operation status
-     */
-    status: BusinessOperationStatus;
+  /**
+   * Business operation status
+   */
+  status: BusinessOperationStatus;
 
-    /**
-     * Business operation payload
-     */
-    payload: T;
+  /**
+   * Business operation payload
+   */
+  payload: T;
 
-    /**
-     * Date when operation was created
-     */
-    dtCreated: Date;
+  /**
+   * Date when operation was created
+   */
+  dtCreated: Date;
 }

package/src/dbScheme/groupedEvent.ts

@@ -1,7 +1,7 @@
-import { ObjectId } from "mongodb";
-import { DecodedEventData, EncodedEventData, EventData } from "../base/event/event";
-import { UserDBScheme } from "./user";
-import { EventAddons } from '../base/event/addons';
+import type { ObjectId } from 'bson';
+import type { DecodedEventData, EncodedEventData, EventData } from '../base/event/event.ts';
+import type { UserDBScheme } from './user.ts';
+import type { EventAddons } from '../base/event/addons/index.ts';
 
 /**
  * Event marks interface for tracking event status
@@ -17,64 +17,70 @@ export interface EventMarks {
  * Event data after grouper-worker transformation to store it in database
  */
 export interface GroupedEventDBScheme {
-    /**
-     * Internal mongo id
-     */
-    _id?: ObjectId;
+  /**
+   * Internal mongo id
+   */
+  _id?: ObjectId;
 
-    /**
-     * Hash for grouping similar events
-     */
-    groupHash: string;
+  /**
+   * Hash for grouping similar events
+   */
+  groupHash: string;
 
-    /**
-     * Number of events repetitions
-     */
-    totalCount: number;
+  /**
+   * Number of events repetitions
+   */
+  totalCount: number;
 
-    /**
-     * Error language type
-     */
-    catcherType: string;
+  /**
+   * Error language type
+   */
+  catcherType: string;
 
-    /**
-     * Event data
-     */
-    payload: EventData<EventAddons>;
+  /**
+   * Event data
+   */
+  payload: EventData<EventAddons>;
 
-    /**
-     * How many users catch this error
-     */
-    usersAffected: number;
+  /**
+   * How many users catch this error
+   */
+  usersAffected: number;
 
-    /**
-     * Array of users who visited this event
-     */
-    visitedBy: UserDBScheme[];
+  /**
+   * Array of users who visited this event
+   */
+  visitedBy: UserDBScheme[];
 
-    /**
-     * Occurrence time
-     * Unix timestamp in seconds (example: 1567009247.576)
-     * (created by the Collector)
-     */
-    timestamp: number;
+  /**
+   * Occurrence time
+   * Unix timestamp in seconds (example: 1567009247.576)
+   * (created by the Collector)
+   */
+  timestamp: number;
 
-    /**
-     * Event marks for tracking status
-     */
-    marks?: EventMarks;
+  /**
+   * Event marks for tracking status
+   */
+  marks?: EventMarks;
 }
 
 /**
- * Grouped event with decoded event data
+ * Event where 'context' and 'addons' are decoded from json strings to objects
  */
 export interface DecodedGroupedEvent extends GroupedEventDBScheme {
-    payload: DecodedEventData<EventAddons>;
+  /**
+   * Event data where 'context' and 'addons' are objects
+   */
+  payload: DecodedEventData<EventAddons>;
 }
 
 /**
- * Grouped event with encoded event data
+ * In database we store 'context' and 'addons' as json strings to avoind mongo keys conflict
  */
 export interface EncodedGroupedEvent extends GroupedEventDBScheme {
-    payload: EncodedEventData;
+  /**
+   * Event data where 'context' and 'addons' are json strings
+   */
+  payload: EncodedEventData;
 }

package/src/dbScheme/membership.ts

@@ -1,44 +1,41 @@
-import { ObjectId } from "mongodb";
+import type { ObjectId } from 'bson';
 
 /**
  * Represents confirmed member info in DB
  */
 export interface ConfirmedMemberDBScheme {
-    /**
-     * Document id
-     */
-    _id: ObjectId;
-
-    /**
-     * Id of the member of workspace
-     */
-    userId: ObjectId;
-
-    /**
-     * Is user admin in workspace
-     */
-    isAdmin?: boolean;
+  /**
+   * Document id
+   */
+  _id: ObjectId;
+
+  /**
+   * Id of the member of workspace
+   */
+  userId: ObjectId;
+
+  /**
+   * Is user admin in workspace
+   */
+  isAdmin?: boolean;
 }
 
-
 /**
  * Represents pending member info in DB
  */
 export interface PendingMemberDBScheme {
-    /**
-     * Document id
-     */
-    _id: ObjectId;
-
-    /**
-     * User email for invitation
-     */
-    userEmail: string;
+  /**
+   * Document id
+   */
+  _id: ObjectId;
+
+  /**
+   * User email for invitation
+   */
+  userEmail: string;
 }
 
-
 /**
  * Represents full structure of team collection documents
  */
 export type MemberDBScheme = ConfirmedMemberDBScheme | PendingMemberDBScheme;
-

package/src/dbScheme/notificationsChannelSettings.ts

@@ -2,18 +2,18 @@
  * Setting of a channel
  */
 export interface NotificationsChannelSettingsDBScheme {
-    /**
-     * Allows to disable channel without removing endpoint
-     */
-    isEnabled: boolean;
+  /**
+   * Allows to disable channel without removing endpoint
+   */
+  isEnabled: boolean;
 
-    /**
-     * Endpoint: email, slack webhook, telegram bot webhook, push subscription id, etc
-     */
-    endpoint: string;
+  /**
+   * Endpoint: email, slack webhook, telegram bot webhook, push subscription id, etc
+   */
+  endpoint: string;
 
-    /**
-     * Minimal pause between second notification, in seconds
-     */
-    minPeriod: number;
+  /**
+   * Minimal pause between second notification, in seconds
+   */
+  minPeriod: number;
 }

package/src/dbScheme/notificationsChannels.ts

@@ -1,36 +1,36 @@
-import { NotificationsChannelSettingsDBScheme } from "../../index";
+import type { NotificationsChannelSettingsDBScheme } from '../../index.ts';
 
 /**
  * Available channels
  */
 export interface NotificationsChannelsDBScheme {
-    /**
-     * Alerts on email
-     */
-    email?: NotificationsChannelSettingsDBScheme;
+  /**
+   * Alerts on email
+   */
+  email?: NotificationsChannelSettingsDBScheme;
 
-    /**
-     * Alerts through the Slack
-     */
-    slack?: NotificationsChannelSettingsDBScheme;
+  /**
+   * Alerts through the Slack
+   */
+  slack?: NotificationsChannelSettingsDBScheme;
 
-    /**
-     * Alerts through the Telegram
-     */
-    telegram?: NotificationsChannelSettingsDBScheme;
+  /**
+   * Alerts through the Telegram
+   */
+  telegram?: NotificationsChannelSettingsDBScheme;
 
-    /**
-     * Browser pushes
-     */
-    webPush?: NotificationsChannelSettingsDBScheme;
+  /**
+   * Browser pushes
+   */
+  webPush?: NotificationsChannelSettingsDBScheme;
 
-    /**
-     * Pushes through the Hawk Desktop app
-     */
-    desktopPush?: NotificationsChannelSettingsDBScheme;
+  /**
+   * Pushes through the Hawk Desktop app
+   */
+  desktopPush?: NotificationsChannelSettingsDBScheme;
 
-    /**
-     * Alerts through the Loop
-     */
-    loop?: NotificationsChannelSettingsDBScheme;
+  /**
+   * Alerts through the Loop
+   */
+  loop?: NotificationsChannelSettingsDBScheme;
 }

package/src/dbScheme/plan.ts

@@ -1,42 +1,42 @@
-import { ObjectId } from "mongodb";
+import type { ObjectId } from 'bson';
 
 /**
  * Plan representation in DataBase
  */
 export interface PlanDBScheme {
-    /**
-     * Plan's id
-     */
-    _id: ObjectId;
+  /**
+   * Plan's id
+   */
+  _id: ObjectId;
 
-    /**
-     * Plan's name
-     */
-    name: string;
+  /**
+   * Plan's name
+   */
+  name: string;
 
-    /**
-     * Monthly charge for plan in currencry specified in `monthlyChargeCurrency`
-     */
-    monthlyCharge: number;
+  /**
+   * Monthly charge for plan in currencry specified in `monthlyChargeCurrency`
+   */
+  monthlyCharge: number;
 
-    /**
-     * Currency of `monthlyCharge`
-     */
-    monthlyChargeCurrency: string;
+  /**
+   * Currency of `monthlyCharge`
+   */
+  monthlyChargeCurrency: string;
 
-    /**
-     * Maximum amount of events available for plan
-     */
-    eventsLimit: number;
+  /**
+   * Maximum amount of events available for plan
+   */
+  eventsLimit: number;
 
-    /**
-     * Is this plan used by default?
-     */
-    isDefault: boolean;
+  /**
+   * Is this plan used by default?
+   */
+  isDefault: boolean;
 
-    /**
-     * Special plans to be selected manually
-     * No one cannot be switched to this plan by api
-     */
-    isHidden?: boolean;
+  /**
+   * Special plans to be selected manually
+   * No one cannot be switched to this plan by api
+   */
+  isHidden?: boolean;
 }