@hawk.so/types 0.1.38 → 0.3.0

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;
 }

package/src/dbScheme/project.ts

@@ -1,6 +1,6 @@
-import { ObjectId } from 'mongodb';
-import { ProjectNotificationsRuleDBScheme } from '../../index';
-import { ProjectEventGroupingPatternsDBScheme } from '../../index';
+import type { ObjectId } from 'bson';
+import type { ProjectNotificationsRuleDBScheme } from '../../index.ts';
+import type { ProjectEventGroupingPatternsDBScheme } from '../../index.ts';
 
 /**
  * Structure represents a Project in DataBase
@@ -13,7 +13,6 @@ export interface ProjectDBScheme {
 
   /**
    * Unique integration id, that's used as collector domain url for sending events
-   *
    * @example `wss://${integrationId}.k1.hawk.so/ws`
    */
   integrationId: string;

package/src/dbScheme/projectEventGroupingPattern.ts

@@ -1,13 +1,17 @@
-import { ObjectId } from "mongodb";
+import type { ObjectId } from 'bson';
 
+/**
+ * Project admin can specify regular expression patterns to group events into categories.
+ * We store them in the database to be able to use them in the UI.
+ */
 export interface ProjectEventGroupingPatternsDBScheme {
   /**
    * If of the pattern
    */
-  _id: ObjectId,
+  _id: ObjectId;
 
   /**
    * String that represents regular expression pattern
    */
-  pattern: string,
-}
+  pattern: string;
+}

package/src/dbScheme/projectNotificationsRule.ts

@@ -1,58 +1,58 @@
-import { ObjectId } from "mongodb";
-import { ReceiveTypes } from "../../index";
-import { NotificationsChannelsDBScheme } from "./notificationsChannels";
+import type { ObjectId } from 'bson';
+import type { ReceiveTypes } from '../../index.ts';
+import type { NotificationsChannelsDBScheme } from './notificationsChannels.ts';
 
 /**
  * This structure represents a single rule of notifications settings
  */
 export interface ProjectNotificationsRuleDBScheme {
-    /**
-     * Id of Rule
-     */
-    _id: ObjectId;
-
-    /**
-     * Allows to disable rule without removing
-     */
-    isEnabled: boolean;
-
-    /**
-     * Creator of the rule
-     */
-    uidAdded: ObjectId;
-
-    /**
-     * Receive type: 'SEEN_MORE'  or 'ONLY_NEW'
-     */
-    whatToReceive: ReceiveTypes;
-
-    /**
-     * Only those which contains passed words
-     */
-    including: string[];
-
-    /**
-     * Skip those which contains passed words
-     */
-    excluding: string[];
-
-    /**
-     * Available channels to receive
-     */
-    channels: NotificationsChannelsDBScheme;
-
-    /**
-     * If this number of events is reached in the eventThresholdPeriod, the rule will be triggered
-     */
-    threshold?: number;
-
-    /**
-     * Size of period (in milliseconds) to count events to compare to rule threshold
-     */
-    thresholdPeriod?: number;
-
-    /**
-     * If rule is created automatically (on project creation or conversion of old projects)
-     */
-    autoAdded?: string;
+  /**
+   * Id of Rule
+   */
+  _id: ObjectId;
+
+  /**
+   * Allows to disable rule without removing
+   */
+  isEnabled: boolean;
+
+  /**
+   * Creator of the rule
+   */
+  uidAdded: ObjectId;
+
+  /**
+   * Receive type: 'SEEN_MORE'  or 'ONLY_NEW'
+   */
+  whatToReceive: ReceiveTypes;
+
+  /**
+   * Only those which contains passed words
+   */
+  including: string[];
+
+  /**
+   * Skip those which contains passed words
+   */
+  excluding: string[];
+
+  /**
+   * Available channels to receive
+   */
+  channels: NotificationsChannelsDBScheme;
+
+  /**
+   * If this number of events is reached in the eventThresholdPeriod, the rule will be triggered
+   */
+  threshold?: number;
+
+  /**
+   * Size of period (in milliseconds) to count events to compare to rule threshold
+   */
+  thresholdPeriod?: number;
+
+  /**
+   * If rule is created automatically (on project creation or conversion of old projects)
+   */
+  autoAdded?: string;
 }

package/src/dbScheme/release.ts

@@ -1,5 +1,5 @@
-import { ObjectId } from "mongodb";
-import { SourceMapDataExtended } from './sourceMap';
+import type { ObjectId } from 'bson';
+import type { SourceMapDataExtended } from './sourceMap.ts';
 
 /**
  * Git commit data stored in the release
@@ -7,28 +7,24 @@ import { SourceMapDataExtended } from './sourceMap';
 export interface CommitData {
   /**
    * Commit hash
-   * 
    * @example 599575d00e62924d08b031defe0a6b10133a75fc
    */
   hash: string;
 
   /**
    * Title of the commit
-   * 
    * @example Hot fix
    */
   title: string;
 
   /**
    * Commit author
-   * 
    * @example codex-team@codex.so
    */
   author: string;
 
   /**
    * Commit date
-   * 
    * @example 2021-04-23T10:54:01.000+00:00
    */
   date: Date;
@@ -44,13 +40,12 @@ export interface ReleaseDBScheme {
   _id: ObjectId;
 
   /**
-   * ProjectId associated with the release 
+   * ProjectId associated with the release
    */
   projectId: string;
 
   /**
    * Release name
-   * 
    * @example Version 1.0
    */
   release: string;