@hawk.so/types 0.2.0 → 0.4.0

package/build/src/dbScheme/sso.d.ts

@@ -0,0 +1,77 @@
+/**
+ * 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/build/src/dbScheme/sso.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * SSO configuration types for database schema
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/src/dbScheme/user.d.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
  */
@@ -67,4 +67,24 @@ 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/build/src/dbScheme/userNotifications.d.ts

@@ -1,4 +1,4 @@
-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)
  */

package/build/src/dbScheme/workspace.d.ts

@@ -1,4 +1,5 @@
-import { ObjectId } from "mongodb";
+import type { ObjectId } from 'bson';
+import type { WorkspaceSsoConfig } from './sso.ts';
 /**
  * Workspace representation in DataBase
  */
@@ -68,4 +69,8 @@ export interface WorkspaceDBScheme {
     lastNotificationDate?: {
         [key: string]: Date;
     };
+    /**
+     * SSO configuration (optional, only for workspaces with SSO enabled)
+     */
+    sso?: WorkspaceSsoConfig;
 }

package/build/src/notifications/createProjectNotifications.d.ts

@@ -1,5 +1,5 @@
-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
  */

package/build/src/notifications/receiveTypes.js

@@ -14,4 +14,4 @@ var ReceiveTypes;
      * Only first occurrence
      */
     ReceiveTypes["ONLY_NEW"] = "ONLY_NEW";
-})(ReceiveTypes = exports.ReceiveTypes || (exports.ReceiveTypes = {}));
+})(ReceiveTypes || (exports.ReceiveTypes = ReceiveTypes = {}));

package/build/src/notifications/updateProjectNotifications.d.ts

@@ -1,5 +1,5 @@
-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
  */

package/build/src/notifications/userNotification.js

@@ -18,4 +18,4 @@ var UserNotificationType;
      * Only important messages from Hawk team
      */
     UserNotificationType["SystemMessages"] = "SystemMessages";
-})(UserNotificationType = exports.UserNotificationType || (exports.UserNotificationType = {}));
+})(UserNotificationType || (exports.UserNotificationType = UserNotificationType = {}));

package/build/src/utils/index.d.ts

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

package/eslint.config.mjs

@@ -0,0 +1,34 @@
+import codex from 'eslint-config-codex';
+import { fileURLToPath } from 'node:url';
+import path from 'node:path';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+export default [
+  ...codex,
+  {
+    languageOptions: {
+      parserOptions: {
+        project: path.resolve(__dirname, 'tsconfig.json'),
+      },
+    },
+    rules: {
+      'object-curly-spacing': ['error', 'always'],
+      '@typescript-eslint/no-empty-interface': 'off',
+      '@typescript-eslint/no-empty-object-type': ['error', { allowInterfaces: 'always' }],
+      '@typescript-eslint/naming-convention': [
+        'error',
+        {
+          selector: 'property',
+          filter: {
+            regex: '^_id$',
+            match: true,
+          },
+          format: null,
+        },
+      ],
+    },
+  },
+];
+

package/index.ts

@@ -28,6 +28,7 @@ export * from "./src/dbScheme/user";
 export * from "./src/dbScheme/userNotifications";
 export * from "./src/dbScheme/workspace";
 export * from "./src/dbScheme/bankCard";
+export * from "./src/dbScheme/sso";
 export * from "./src/dbScheme/projectEventGroupingPattern";
 
 export * from "./src/notifications/createProjectNotifications";

package/package.json

@@ -1,21 +1,26 @@
 {
   "name": "@hawk.so/types",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "TypeScript definitions for Hawk",
   "types": "build/index.d.ts",
   "main": "build/index.js",
   "repository": "https://github.com/codex-team/hawk.types.git",
   "license": "AGPL-3.0-only",
+  "engines": {
+    "node": "24.x",
+    "yarn": ">=1.22.0"
+  },
+  "packageManager": "yarn@1.22.0",
   "scripts": {
-    "lint": "eslint src/ --ext .ts --fix",
+    "lint": "eslint src/ --fix",
     "build": "tsc"
   },
   "dependencies": {
-    "@types/mongodb": "^3.5.34"
+    "bson": "^7.0.0"
   },
   "devDependencies": {
-    "eslint": "^7.14.0",
-    "eslint-config-codex": "^1.4.0",
-    "typescript": "^4.1.2"
+    "eslint": "^9.39.2",
+    "eslint-config-codex": "^2.0.3",
+    "typescript": "^5.9.3"
   }
 }

package/src/auth/tokensPair.ts

@@ -3,13 +3,13 @@
  * Authorization by access token and refreshing pair by refresh token (after access token was expired).
  */
 export interface TokensPair {
-    /**
-     * User's access token
-     */
-    accessToken: string;
+  /**
+   * User's access token
+   */
+  accessToken: string;
 
-    /**
-     * User's refresh token for getting new tokens pair
-     */
-    refreshToken: string;
-}
+  /**
+   * User's refresh token for getting new tokens pair
+   */
+  refreshToken: string;
+}

package/src/base/businessOperation/businessOperation.ts

@@ -1,4 +1,4 @@
-import { ObjectId } from 'mongodb';
+import type { ObjectId } from 'bson';
 
 /**
  * Business operations statuses
@@ -7,17 +7,17 @@ export enum BusinessOperationStatus {
   /**
    * Business operation is pending
    */
-  Pending='PENDING',
+  Pending = 'PENDING',
 
   /**
    * Business operation is confirmed
    */
-  Confirmed='CONFIRMED',
+  Confirmed = 'CONFIRMED',
 
   /**
    * Business operation is rejected
    */
-  Rejected='REJECTED'
+  Rejected = 'REJECTED'
 }
 
 /**
@@ -34,13 +34,13 @@ export enum BusinessOperationType {
    */
   DepositByUser = 'DEPOSIT_BY_USER',
   /**
- * Charge minimal amount of money to link a card for further recurrent payments
- */
+   * Charge minimal amount of money to link a card for further recurrent payments
+   */
   CardLinkCharge = 'CARD_LINK_CHARGE',
   /**
    * Refund the money that were charged to link a card
    */
-  CardLinkRefund = 'CARD_LINK_REFUND',
+  CardLinkRefund = 'CARD_LINK_REFUND'
 }
 
 /**
@@ -100,7 +100,7 @@ export interface PayloadOfWorkspacePlanPurchase {
   /**
    * Id of the workspace tariff plan
    */
-  tariffPlanId: ObjectId
+  tariffPlanId: ObjectId;
 }
 
 /**

package/src/base/event/addons/default.ts

@@ -1,4 +1,4 @@
-import { SentryAddons } from "./sentry";
+import type { SentryAddons } from './sentry.ts';
 
 /**
  * This interface represents data that can be additionally collected by Default Catcher

package/src/base/event/addons/index.ts

@@ -1,10 +1,10 @@
-import { JavaScriptAddons, WindowData, VueIntegrationAddons, BeautifiedUserAgent, ConsoleLogEvent } from './javascript';
-import { PhpAddons } from './php';
-import { NodeJSAddons } from './nodejs';
-import { GoAddons } from './go';
-import { PythonAddons } from './python';
-import { DefaultAddons } from './default';
-import { SentryAddons } from './sentry';
+import type { JavaScriptAddons, WindowData, VueIntegrationAddons, BeautifiedUserAgent, ConsoleLogEvent } from './javascript.ts';
+import type { PhpAddons } from './php.ts';
+import type { NodeJSAddons } from './nodejs.ts';
+import type { GoAddons } from './go.ts';
+import type { PythonAddons } from './python.ts';
+import type { DefaultAddons } from './default.ts';
+import type { SentryAddons } from './sentry.ts';
 
 /**
  * Union Type describing all catcher-specific additional data
@@ -16,11 +16,10 @@ type EventAddons =
   | NodeJSAddons
   | GoAddons
   | PythonAddons
-  | DefaultAddons
-  | SentryAddons;
 
+  | SentryAddons;
 
-export {
+export type {
   WindowData,
   VueIntegrationAddons,
   BeautifiedUserAgent,
@@ -32,5 +31,5 @@ export {
   NodeJSAddons,
   GoAddons,
   PythonAddons,
-  SentryAddons,
-}
+  SentryAddons
+};

package/src/base/event/addons/javascript.ts

@@ -1,5 +1,5 @@
-import { Json } from '../../../utils';
-import { SentryAddons } from './sentry';
+import type { Json } from '../../../utils/index.ts';
+import type { SentryAddons } from './sentry.ts';
 
 /**
  * Parsed user agent

package/src/base/event/addons/php.ts

@@ -1,4 +1,4 @@
-import { Json } from '../../../utils';
+import type { Json } from '../../../utils/index.ts';
 
 /**
  * This interface represents data that can be additionally collected by PHP Catcher

package/src/base/event/addons/sentry.ts

@@ -1,4 +1,4 @@
-
+/* eslint-disable jsdoc/require-jsdoc */
 /**
  * Additional data extracted from the Sentry event payload
  */
@@ -17,6 +17,7 @@ export interface SentryAddons {
   request?: {
     url?: string;
     method?: string;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     data?: any;
     query_string?: string | {
       [key: string]: string;
@@ -41,3 +42,4 @@ export interface SentryAddons {
   };
   extra?: Record<string, unknown>;
 }
+/* eslint-enable jsdoc/require-jsdoc */

package/src/base/event/affectedUser.ts

@@ -2,23 +2,23 @@
  * Represents affected user object
  */
 export interface AffectedUser {
-    /**
-     * Internal user's identifier inside an app
-     */
-    id: string;
+  /**
+   * Internal user's identifier inside an app
+   */
+  id: string;
 
-    /**
-     * User public name
-     */
-    name?: string;
+  /**
+   * User public name
+   */
+  name?: string;
 
-    /**
-     * URL for user's details page
-     */
-    url?: string;
+  /**
+   * URL for user's details page
+   */
+  url?: string;
 
-    /**
-     * User's public picture
-     */
-    photo?: string;
+  /**
+   * User's public picture
+   */
+  photo?: string;
 }

package/src/base/event/backtraceFrame.ts

@@ -1,36 +1,36 @@
-import { SourceCodeLine } from "./sourceCodeLine";
+import type { SourceCodeLine } from './sourceCodeLine.ts';
 
 /**
  * Single item of backtrace
  */
 export interface BacktraceFrame {
-    /**
-     * File
-     */
-    file: string;
+  /**
+   * File
+   */
+  file: string;
 
-    /**
-     * Line number
-     */
-    line: number;
+  /**
+   * Line number
+   */
+  line: number;
 
-    /**
-     * Column number
-     */
-    column?: number;
+  /**
+   * Column number
+   */
+  column?: number;
 
-    /**
-     * Sibling source code lines: some above and some below
-     */
-    sourceCode?: SourceCodeLine[];
+  /**
+   * Sibling source code lines: some above and some below
+   */
+  sourceCode?: SourceCodeLine[];
 
-    /**
-     * Function name extracted from current stack frame
-     */
-    function?: string;
+  /**
+   * Function name extracted from current stack frame
+   */
+  function?: string;
 
-    /**
-     * Function arguments extracted from current stack frame
-     */
-    arguments?: string[];
+  /**
+   * Function arguments extracted from current stack frame
+   */
+  arguments?: string[];
 }

package/src/base/event/breadcrumb.ts

@@ -1,4 +1,4 @@
-import { Json } from '../../utils';
+import type { Json } from '../../utils/index.ts';
 
 /**
  * Breadcrumb severity level
@@ -11,11 +11,11 @@ export type BreadcrumbLevel = 'fatal' | 'error' | 'warning' | 'info' | 'debug';
  */
 export type BreadcrumbType =
   | 'default'
-  | 'request'    // fetch, xhr, db calls, etc
-  | 'ui'         // click, mousemove, scroll, etc
+  | 'request' // fetch, xhr, db calls, etc
+  | 'ui' // click, mousemove, scroll, etc
   | 'navigation' // page open, route change, etc
-  | 'logic'      // gql resolvers, internal methods calls, etc
-  | 'error';     // errors, exceptions, etc
+  | 'logic' // gql resolvers, internal methods calls, etc
+  | 'error'; // errors, exceptions, etc
 
 /**
  * Single breadcrumb entry - represents an event that occurred before the error
@@ -26,7 +26,6 @@ export interface Breadcrumb {
    * Unix timestamp in milliseconds since epoch (e.g., 1701867896789)
    *
    * Note: This field uses milliseconds format
-   *
    * @example 1701867896789
    */
   timestamp: number;
@@ -44,7 +43,6 @@ export interface Breadcrumb {
    * - For type='request': "fetch", "xhr", "db.query", "db.insert"
    * - For type='logic': "gql.resolver", "service.method", "middleware.auth"
    * - For type='navigation': "history.push", "history.replace", "route.change"
-   *
    * @example "ui.click"
    * @example "fetch"
    * @example "gql.resolver"
@@ -53,7 +51,6 @@ export interface Breadcrumb {
 
   /**
    * Human-readable message describing the event
-   *
    * @example "GET /api/profile 200"
    * @example "Click on button#submit"
    * @example "Navigated to /dashboard"
@@ -71,4 +68,3 @@ export interface Breadcrumb {
    */
   data?: Record<string, Json>;
 }
-