@hawk.so/types 0.2.0 → 0.3.0

package/src/dbScheme/repetition.ts

@@ -1,48 +1,57 @@
-import { ObjectId } from "mongodb";
-import { DecodedEventData, EncodedEventData, EventData } from '../base/event/event';
-import { EventAddons } from '../base/event/addons';
+import type { ObjectId } from 'bson';
+import type { DecodedEventData, EncodedEventData, EventData } from '../base/event/event.ts';
+import type { EventAddons } from '../base/event/addons/index.ts';
 
+/**
+ * Repetition - is a record about event that was already processed. It stores only difference between original event and repetition.
+ */
 export interface RepetitionDBScheme {
-    /**
-     * Internal mongo id
-     */
-    _id?: ObjectId;
+  /**
+   * Internal mongo id
+   */
+  _id?: ObjectId;
+
+  /**
+   * Hash for grouping similar events
+   */
+  groupHash: string;
 
-    /**
-     * Hash for grouping similar events
-     */
-    groupHash: string;
+  /**
+   * @deprecated use delta instead
+   * And any of EventData field with diff
+   * except fields that used in groupHash
+   */
+  payload?: EventData<EventAddons>;
 
-    /**
-     * @deprecated, use delta instead
-     * And any of EventData field with diff
-     * except fields that used in groupHash
-     */
-    payload?: EventData<EventAddons>;
+  /**
+   * Delta between original event and repetition
+   */
+  delta?: string;
 
-    /**
-     * Delta between original event and repetition
-     */
-    delta?: string,
-    
-    /**
-     * 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;
 }
 
 /**
  * Repetition with decoded event data
  */
 export interface DecodedRepetition {
-    payload: DecodedEventData<EventAddons>
+  /**
+   * Event data where 'context' and 'addons' are objects
+   */
+  payload: DecodedEventData<EventAddons>;
 }
 
 /**
  * Repetition with decoded event data
  */
 export interface EncodedRepetition {
-    payload: EncodedEventData
+  /**
+   * Event data where 'context' and 'addons' are json strings
+   */
+  payload: EncodedEventData;
 }

package/src/dbScheme/sourceMap.ts

@@ -1,4 +1,4 @@
-import { ObjectID, Timestamp } from 'mongodb';
+import type { ObjectId, Timestamp } from 'bson';
 
 /**
  * Source map with parsed file names, stored in the release
@@ -6,14 +6,12 @@ import { ObjectID, Timestamp } from 'mongodb';
 export interface SourceMapDataExtended {
   /**
    * Name of source-map file
-   *
    * @example main.min.js.map
    */
   mapFileName: string;
 
   /**
    * Bundle or chunk name
-   *
    * @example main.min.js
    */
   originFileName: string;
@@ -27,19 +25,18 @@ export interface SourceMapDataExtended {
   /**
    * When file will be saved to GridFS, there will be its id instead of 'content'
    */
-  _id?: ObjectID;
+  _id?: ObjectId;
 }
 
 /**
  * Object represents a file structure stored in Mongo GridFS
- *
  * @see https://github.com/mongodb/specifications/blob/master/source/gridfs/gridfs-spec.rst#definitions
  */
 export interface SourceMapFileChunk {
   /**
    * Unique id of a file chunk
    */
-  _id: ObjectID;
+  _id: ObjectId;
 
   /**
    * Chunk size in bytes
@@ -53,7 +50,6 @@ export interface SourceMapFileChunk {
 
   /**
    * Uploading date  stored as a BSON datetime value 'Timestamp'.
-   *
    * @example 2020-02-18T14:51:40.400Z
    */
   uploadDate: Timestamp;
@@ -82,4 +78,4 @@ export interface SourcemapCollectedData {
    * Source map body
    */
   payload: string;
-}
+}

package/src/dbScheme/user.ts

@@ -1,6 +1,6 @@
-import { ObjectId } from 'mongodb';
-import { UserNotificationsDBScheme } from '../../index';
-import { BankCard } from './bankCard';
+import type { ObjectId } from 'bson';
+import type { UserNotificationsDBScheme } from '../../index.ts';
+import type { BankCard } from './bankCard.ts';
 
 /**
  * Interface representing how user is stored in DB

package/src/dbScheme/userNotifications.ts

@@ -1,16 +1,16 @@
-import { NotificationsChannelsDBScheme, UserNotificationType } from "../../index";
+import type { NotificationsChannelsDBScheme, UserNotificationType } from '../../index.ts';
 
 /**
  * This structure represents how user notifications are stored at the DB (in 'users' collection)
  */
 export interface UserNotificationsDBScheme {
-    /**
-     * Channels with their settings
-     */
-    channels: NotificationsChannelsDBScheme;
+  /**
+   * Channels with their settings
+   */
+  channels: NotificationsChannelsDBScheme;
 
-    /**
-     * Types of notifications to receive
-     */
-    whatToReceive: {[key in UserNotificationType]: boolean};
+  /**
+   * Types of notifications to receive
+   */
+  whatToReceive: { [key in UserNotificationType]: boolean };
 }

package/src/dbScheme/workspace.ts

@@ -1,84 +1,84 @@
-import { ObjectId } from "mongodb";
+import type { ObjectId } from 'bson';
 
 /**
  * Workspace representation in DataBase
  */
 export interface WorkspaceDBScheme {
-    /**
-     * Workspace's id
-     */
-    _id: ObjectId;
+  /**
+   * Workspace's id
+   */
+  _id: ObjectId;
 
-    /**
-     * Workspace's name
-     */
-    name: string;
+  /**
+   * Workspace's name
+   */
+  name: string;
 
-    /**
-     * Workspace's invite hash
-     */
-    inviteHash: string;
+  /**
+   * Workspace's invite hash
+   */
+  inviteHash: string;
 
-    /**
-     * Workspace account uuid in accounting microservice
-     */
-    accountId: string;
+  /**
+   * Workspace account uuid in accounting microservice
+   */
+  accountId: string;
 
-    /**
-     * Workspace's description
-     */
-    description?: string;
+  /**
+   * Workspace's description
+   */
+  description?: string;
 
-    /**
-     * Workspace's image URL
-     */
-    image?: string;
+  /**
+   * Workspace's image URL
+   */
+  image?: string;
 
-    /**
-     * Id of the Workspace's plan
-     */
-    tariffPlanId: ObjectId;
+  /**
+   * Id of the Workspace's plan
+   */
+  tariffPlanId: ObjectId;
 
-    /**
-     * Workspace balance
-     */
-    balance: number;
+  /**
+   * Workspace balance
+   */
+  balance: number;
 
-    /**
-     * Date when workspace was charged last time
-     */
-    lastChargeDate: Date;
+  /**
+   * Date when workspace was charged last time
+   */
+  lastChargeDate: Date;
 
-    /**
-     * Date when subscription will be expired
-     * Used for pre-paid plans for several months
-     */
-    paidUntil?: Date;
+  /**
+   * Date when subscription will be expired
+   * Used for pre-paid plans for several months
+   */
+  paidUntil?: Date;
 
-    /**
-     * Total number of errors since the last charge date
-     */
-    billingPeriodEventsCount: number;
+  /**
+   * Total number of errors since the last charge date
+   */
+  billingPeriodEventsCount: number;
 
-    /**
-     * ID of subscription if it subscribed
-     * Returns from CloudPayments
-     */
-    subscriptionId?: string;
+  /**
+   * ID of subscription if it subscribed
+   * Returns from CloudPayments
+   */
+  subscriptionId?: string;
 
-    /**
-     * Is workspace blocked for catching new events
-     */
-    isBlocked?: boolean;
+  /**
+   * Is workspace blocked for catching new events
+   */
+  isBlocked?: boolean;
 
-    /**
-     * Date when workspace was blocked
-     */
-    blockedDate?: Date;
+  /**
+   * Date when workspace was blocked
+   */
+  blockedDate?: Date;
 
-    /**
-     * List of last dates for notifications
-     * Used to reduce frequency of some system messages
-     */
-    lastNotificationDate?: {[key: string]: Date};
+  /**
+   * List of last dates for notifications
+   * Used to reduce frequency of some system messages
+   */
+  lastNotificationDate?: { [key: string]: Date };
 }

package/src/notifications/createProjectNotifications.ts

@@ -1,37 +1,37 @@
-import { ReceiveTypes } from "../../index";
-import { NotificationsChannelsDBScheme } from "../dbScheme/notificationsChannels";
+import type { ReceiveTypes } from '../../index.ts';
+import type { NotificationsChannelsDBScheme } from '../dbScheme/notificationsChannels.ts';
 
 /**
  * Payload for creating new notification rule
  */
 export interface CreateProjectNotificationsRulePayload {
-    /**
-     * Allows to disable rule without removing
-     */
-    isEnabled: true;
+  /**
+   * Allows to disable rule without removing
+   */
+  isEnabled: true;
 
-    /**
-     * Receive type: 'ALL'  or 'ONLY_NEW'
-     */
-    whatToReceive: ReceiveTypes;
+  /**
+   * Receive type: 'ALL'  or 'ONLY_NEW'
+   */
+  whatToReceive: ReceiveTypes;
 
-    /**
-     * Only those which contains passed words
-     */
-    including: string[];
+  /**
+   * Only those which contains passed words
+   */
+  including: string[];
 
-    /**
-     * Skip those which contains passed words
-     */
-    excluding: string[];
+  /**
+   * Skip those which contains passed words
+   */
+  excluding: string[];
 
-    /**
-     * Creator of the rule
-     */
-    uidAdded: string;
+  /**
+   * Creator of the rule
+   */
+  uidAdded: string;
 
-    /**
-     * Available channels to receive
-     */
-    channels: NotificationsChannelsDBScheme;
-}
+  /**
+   * Available channels to receive
+   */
+  channels: NotificationsChannelsDBScheme;
+}

package/src/notifications/receiveTypes.ts

@@ -2,13 +2,13 @@
  * Available options of 'What to receive'
  */
 export enum ReceiveTypes {
-    /**
-     * If event seen more than threshold in thresholdPeriod
-     */
-    SEEN_MORE = 'SEEN_MORE',
+  /**
+   * If event seen more than threshold in thresholdPeriod
+   */
+  SEEN_MORE = 'SEEN_MORE',
 
-    /**
-     * Only first occurrence
-     */
-    ONLY_NEW = 'ONLY_NEW',
+  /**
+   * Only first occurrence
+   */
+  ONLY_NEW = 'ONLY_NEW'
 }

package/src/notifications/updateProjectNotifications.ts

@@ -1,37 +1,37 @@
-import { ReceiveTypes } from "../../index";
-import { NotificationsChannelsDBScheme } from "../dbScheme/notificationsChannels";
+import type { ReceiveTypes } from '../../index.ts';
+import type { NotificationsChannelsDBScheme } from '../dbScheme/notificationsChannels.ts';
 
 /**
  * Payload for updating existing notifications rule
  */
 export interface UpdateProjectNotificationsRulePayload {
-    /**
-     * Rule id to update
-     */
-    ruleId: string;
+  /**
+   * Rule id to update
+   */
+  ruleId: string;
 
-    /**
-     * Allows to disable rule without removing
-     */
-    isEnabled: true;
+  /**
+   * Allows to disable rule without removing
+   */
+  isEnabled: true;
 
-    /**
-     * Receive type: 'ALL'  or 'ONLY_NEW'
-     */
-    whatToReceive: ReceiveTypes;
+  /**
+   * Receive type: 'ALL'  or 'ONLY_NEW'
+   */
+  whatToReceive: ReceiveTypes;
 
-    /**
-     * Only those which contains passed words
-     */
-    including: string[];
+  /**
+   * Only those which contains passed words
+   */
+  including: string[];
 
-    /**
-     * Skip those which contains passed words
-     */
-    excluding: string[];
+  /**
+   * Skip those which contains passed words
+   */
+  excluding: string[];
 
-    /**
-     * Available channels to receive
-     */
-    channels: NotificationsChannelsDBScheme;
+  /**
+   * Available channels to receive
+   */
+  channels: NotificationsChannelsDBScheme;
 }

package/src/notifications/userNotification.ts

@@ -2,18 +2,18 @@
  * Available options of 'What to receive'
  */
 export enum UserNotificationType {
-    /**
-     * When user is assigned to the issue (event)
-     */
-    IssueAssigning = 'IssueAssigning',
+  /**
+   * When user is assigned to the issue (event)
+   */
+  IssueAssigning = 'IssueAssigning',
 
-    /**
-     * Regular digest of what happened on the project for the week
-     */
-    WeeklyDigest = 'WeeklyDigest',
+  /**
+   * Regular digest of what happened on the project for the week
+   */
+  WeeklyDigest = 'WeeklyDigest',
 
-    /**
-     * Only important messages from Hawk team
-     */
-    SystemMessages = 'SystemMessages',
+  /**
+   * Only important messages from Hawk team
+   */
+  SystemMessages = 'SystemMessages'
 }

package/src/utils/index.ts

@@ -1,7 +1,7 @@
 /**
  * Represents simple JSON-like document
  */
-export type Json = {[key: string]: JsonNode};
+export type Json = { [key: string]: JsonNode };
 
 /**
  * Represents possible field values in Dict

package/.eslintrc

@@ -1,12 +0,0 @@
-{
-  "parser": "@typescript-eslint/parser",
-  "plugins": ["@typescript-eslint"],
-  "extends": [
-    "eslint:recommended",
-    "plugin:@typescript-eslint/recommended"
-  ],
-  "rules": {
-    "object-curly-spacing": ["error", "always"],
-    "@typescript-eslint/no-empty-interface": ["off"]
-  }
-}