@hawk.so/types 0.2.0 → 0.4.0

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;

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/sso.ts

@@ -0,0 +1,88 @@
+/**
+ * SSO configuration types for database schema
+ */
+
+/**
+ * SAML attribute mapping configuration
+ */
+export interface SamlAttributeMapping {
+  /**
+   * Attribute name for email in SAML Assertion
+   * @example "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress"
+   * to get email from XML like this:
+   *  <Attribute Name="http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress">
+   *    <AttributeValue>alice@company.com</AttributeValue>
+   *  </Attribute>
+   */
+  email: string;
+
+  /**
+   * Attribute name for user name in SAML Assertion
+   */
+  name?: string;
+}
+
+/**
+ * SAML SSO configuration
+ */
+export interface SamlConfig {
+  /**
+   * IdP Entity ID.
+   * Used to validate "this response is intended for Hawk"
+   * @example "urn:hawk:tracker:saml"
+   */
+  idpEntityId: string;
+
+  /**
+   * SSO URL for redirecting user to IdP
+   * Used to redirect user to IdP for authentication
+   * @example "https://idp.example.com/sso"
+   */
+  ssoUrl: string;
+
+  /**
+   * X.509 certificate for signature verification
+   * @example "-----BEGIN CERTIFICATE-----\nMIIDYjCCAkqgAwIBAgI...END CERTIFICATE-----"
+   */
+  x509Cert: string;
+
+  /**
+   * Desired NameID format
+   * @example "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress"
+   */
+  nameIdFormat?: string;
+
+  /**
+   * Attribute mapping configuration
+   * Used to extract user attributes from SAML Response
+   */
+  attributeMapping: SamlAttributeMapping;
+}
+
+/**
+ * SSO configuration for workspace
+ */
+export interface WorkspaceSsoConfig {
+  /**
+   * Is SSO enabled
+   */
+  enabled: boolean;
+
+  /**
+   * Is SSO enforced (only SSO login allowed)
+   * If true, login via email/password is not allowed
+   */
+  enforced: boolean;
+
+  /**
+   * SSO provider type
+   * Currently only SAML is supported. In future we can add other providers (OAuth 2, etc.)
+   */
+  type: 'saml';
+
+  /**
+   * SAML-specific configuration.
+   * Got from IdP metadata.
+   */
+  saml: SamlConfig;
+}

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
@@ -81,4 +81,26 @@ export interface UserDBScheme {
      */
     term?: string;
   };
+
+  /**
+   * External identities for SSO (keyed by workspaceId)
+   */
+  identities?: {
+    [workspaceId: string]: {
+      /**
+       * SAML-mode params
+       */
+      saml: {
+        /**
+         * NameID value from IdP (stable identifier)
+         */
+        id: string;
+
+        /**
+         * Email at the time of linking (for audit)
+         */
+        email: string;
+      };
+    };
+  };
 }

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,90 @@
-import { ObjectId } from "mongodb";
+import type { ObjectId } from 'bson';
+import type { WorkspaceSsoConfig } from './sso.ts';
 
 /**
  * Workspace representation in DataBase
  */
 export interface WorkspaceDBScheme {
-    /**
-     * Workspace's id
-     */
-    _id: ObjectId;
-
-    /**
-     * Workspace's name
-     */
-    name: string;
-
-    /**
-     * Workspace's invite hash
-     */
-    inviteHash: string;
-
-    /**
-     * Workspace account uuid in accounting microservice
-     */
-    accountId: string;
-
-    /**
-     * Workspace's description
-     */
-    description?: string;
-
-    /**
-     * Workspace's image URL
-     */
-    image?: string;
-
-    /**
-     * Id of the Workspace's plan
-     */
-    tariffPlanId: ObjectId;
-
-    /**
-     * Workspace balance
-     */
-    balance: number;
-
-    /**
-     * 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;
-
-    /**
-     * Total number of errors since the last charge date
-     */
-    billingPeriodEventsCount: number;
-
-    /**
-     * ID of subscription if it subscribed
-     * Returns from CloudPayments
-     */
-    subscriptionId?: string;
-
-    /**
-     * Is workspace blocked for catching new events
-     */
-    isBlocked?: boolean;
-
-    /**
-     * 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};
+  /**
+   * Workspace's id
+   */
+  _id: ObjectId;
+
+  /**
+   * Workspace's name
+   */
+  name: string;
+
+  /**
+   * Workspace's invite hash
+   */
+  inviteHash: string;
+
+  /**
+   * Workspace account uuid in accounting microservice
+   */
+  accountId: string;
+
+  /**
+   * Workspace's description
+   */
+  description?: string;
+
+  /**
+   * Workspace's image URL
+   */
+  image?: string;
+
+  /**
+   * Id of the Workspace's plan
+   */
+  tariffPlanId: ObjectId;
+
+  /**
+   * Workspace balance
+   */
+  balance: number;
+
+  /**
+   * 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;
+
+  /**
+   * Total number of errors since the last charge date
+   */
+  billingPeriodEventsCount: number;
+
+  /**
+   * ID of subscription if it subscribed
+   * Returns from CloudPayments
+   */
+  subscriptionId?: string;
+
+  /**
+   * Is workspace blocked for catching new events
+   */
+  isBlocked?: boolean;
+
+  /**
+   * 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 };
+
+  /**
+   * SSO configuration (optional, only for workspaces with SSO enabled)
+   */
+  sso?: WorkspaceSsoConfig;
 }