@hawk.so/types 0.2.0 → 0.4.0

package/.github/workflows/bump-version.yml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       # Checkout to target branch
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
@@ -36,12 +36,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       # Checkout to target branch
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       # Setup node environment
-      - uses: actions/setup-node@v1
+      - uses: actions/setup-node@v4
         with:
-          node-version: 15
+          node-version-file: '.nvmrc'
           registry-url: https://registry.npmjs.org/
 
       # Bump version to the next prerelease (patch) with rc suffix

package/.github/workflows/lint-and-build.yml

@@ -7,11 +7,11 @@ jobs:
     name: Lint and Build
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - name: Use Node.js 15
-        uses: actions/setup-node@v1
+      - uses: actions/checkout@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
         with:
-          node-version: 15
+          node-version-file: '.nvmrc'
 
       - run: yarn
       - run: yarn lint

package/.github/workflows/npm-publish.yml

@@ -9,10 +9,10 @@ jobs:
   publish:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 12
+          node-version-file: '.nvmrc'
           registry-url: https://registry.npmjs.org/
       - run: yarn
       - run: yarn lint
@@ -24,7 +24,7 @@ jobs:
     needs: publish
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Get package info
         id: package
         uses: codex-team/action-nodejs-package-info@v1

package/.nvmrc

@@ -0,0 +1 @@
+v24.11.1

package/build/index.d.ts

@@ -23,6 +23,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";
 export * from "./src/notifications/receiveTypes";

package/build/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -35,6 +39,7 @@ __exportStar(require("./src/dbScheme/user"), exports);
 __exportStar(require("./src/dbScheme/userNotifications"), exports);
 __exportStar(require("./src/dbScheme/workspace"), exports);
 __exportStar(require("./src/dbScheme/bankCard"), exports);
+__exportStar(require("./src/dbScheme/sso"), exports);
 __exportStar(require("./src/dbScheme/projectEventGroupingPattern"), exports);
 __exportStar(require("./src/notifications/createProjectNotifications"), exports);
 __exportStar(require("./src/notifications/receiveTypes"), exports);

package/build/src/base/businessOperation/businessOperation.d.ts

@@ -1,4 +1,4 @@
-import { ObjectId } from 'mongodb';
+import type { ObjectId } from 'bson';
 /**
  * Business operations statuses
  */
@@ -29,8 +29,8 @@ export declare 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
@@ -90,4 +90,4 @@ export interface PayloadOfWorkspacePlanPurchase {
 /**
  * Type of business operation payload, it depends of type field
  */
-export declare type BusinessOperationPayloadType = PayloadOfDepositByUser | PayloadOfWorkspacePlanPurchase;
+export type BusinessOperationPayloadType = PayloadOfDepositByUser | PayloadOfWorkspacePlanPurchase;

package/build/src/base/businessOperation/businessOperation.js

@@ -18,7 +18,7 @@ var BusinessOperationStatus;
      * Business operation is rejected
      */
     BusinessOperationStatus["Rejected"] = "REJECTED";
-})(BusinessOperationStatus = exports.BusinessOperationStatus || (exports.BusinessOperationStatus = {}));
+})(BusinessOperationStatus || (exports.BusinessOperationStatus = BusinessOperationStatus = {}));
 /**
  * Types of business operations
  */
@@ -33,11 +33,11 @@ var BusinessOperationType;
      */
     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
+     */
     BusinessOperationType["CardLinkCharge"] = "CARD_LINK_CHARGE";
     /**
      * Refund the money that were charged to link a card
      */
     BusinessOperationType["CardLinkRefund"] = "CARD_LINK_REFUND";
-})(BusinessOperationType = exports.BusinessOperationType || (exports.BusinessOperationType = {}));
+})(BusinessOperationType || (exports.BusinessOperationType = BusinessOperationType = {}));

package/build/src/base/event/addons/default.d.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/build/src/base/event/addons/index.d.ts

@@ -1,12 +1,12 @@
-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
  */
-declare type EventAddons = DefaultAddons | JavaScriptAddons | PhpAddons | NodeJSAddons | GoAddons | PythonAddons | DefaultAddons | SentryAddons;
-export { WindowData, VueIntegrationAddons, BeautifiedUserAgent, ConsoleLogEvent, EventAddons, DefaultAddons, JavaScriptAddons, PhpAddons, NodeJSAddons, GoAddons, PythonAddons, SentryAddons, };
+type EventAddons = DefaultAddons | JavaScriptAddons | PhpAddons | NodeJSAddons | GoAddons | PythonAddons | SentryAddons;
+export type { WindowData, VueIntegrationAddons, BeautifiedUserAgent, ConsoleLogEvent, EventAddons, DefaultAddons, JavaScriptAddons, PhpAddons, NodeJSAddons, GoAddons, PythonAddons, SentryAddons };

package/build/src/base/event/addons/javascript.d.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/build/src/base/event/addons/php.d.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/build/src/base/event/addons/sentry.js

@@ -1,2 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-enable jsdoc/require-jsdoc */

package/build/src/base/event/backtraceFrame.d.ts

@@ -1,4 +1,4 @@
-import { SourceCodeLine } from "./sourceCodeLine";
+import type { SourceCodeLine } from './sourceCodeLine.ts';
 /**
  * Single item of backtrace
  */

package/build/src/base/event/breadcrumb.d.ts

@@ -1,13 +1,13 @@
-import { Json } from '../../utils';
+import type { Json } from '../../utils/index.ts';
 /**
  * Breadcrumb severity level
  */
-export declare type BreadcrumbLevel = 'fatal' | 'error' | 'warning' | 'info' | 'debug';
+export type BreadcrumbLevel = 'fatal' | 'error' | 'warning' | 'info' | 'debug';
 /**
  * Breadcrumb type - controls categorization and UI appearance
  * Common types suitable for both client and backend
  */
-export declare type BreadcrumbType = 'default' | 'request' | 'ui' | 'navigation' | 'logic' | 'error';
+export type BreadcrumbType = 'default' | 'request' | 'ui' | 'navigation' | 'logic' | 'error';
 /**
  * Single breadcrumb entry - represents an event that occurred before the error
  */
@@ -17,7 +17,6 @@ export interface Breadcrumb {
      * Unix timestamp in milliseconds since epoch (e.g., 1701867896789)
      *
      * Note: This field uses milliseconds format
-     *
      * @example 1701867896789
      */
     timestamp: number;
@@ -33,7 +32,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"
@@ -41,7 +39,6 @@ export interface Breadcrumb {
     category?: string;
     /**
      * Human-readable message describing the event
-     *
      * @example "GET /api/profile 200"
      * @example "Click on button#submit"
      * @example "Navigated to /dashboard"

package/build/src/base/event/event.d.ts

@@ -1,8 +1,7 @@
-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
@@ -29,10 +28,6 @@ export interface EventData<Addons extends EventAddons> {
      * Current release (aka version, revision) of an application
      */
     release?: string;
-    /**
-     * Breadcrumbs - chronological trail of events before the error
-     */
-    breadcrumbs?: Breadcrumb[];
     /**
      * Current authenticated user
      */
@@ -75,4 +70,4 @@ export interface EncodedEventData extends EventData<EventAddons> {
 /**
  * Context is any additional data sent by developer
  */
-export declare type EventContext = Json;
+export type EventContext = Json;

package/build/src/base/integrations/integrationToken.d.ts

@@ -1,7 +1,7 @@
 /**
  * Encoded integration token format
  */
-export declare type EncodedIntegrationToken = string;
+export type EncodedIntegrationToken = string;
 /**
  * Fields in decoded integration token
  */

package/build/src/catchers/catcher-message.d.ts

@@ -1,29 +1,50 @@
-import { DecodedEventData, EventData } from '../base/event/event';
-import { PerformanceData } from '../base/performance/performance';
-import type { JavaScriptAddons, PhpAddons, NodeJSAddons, GoAddons, PythonAddons, DefaultAddons } from '../base/event/addons';
+import type { DecodedEventData, EventData } from '../base/event/event.ts';
+import type { PerformanceData } from '../base/performance/performance.ts';
+import type { JavaScriptAddons, PhpAddons, NodeJSAddons, GoAddons, PythonAddons, DefaultAddons } from '../base/event/addons/index.ts';
 /**
  * Type that represents all supported Catcher message types for events
  */
-export declare type ErrorsCatcherType = 'errors/javascript' | 'errors/php' | 'errors/nodejs' | 'errors/go' | 'errors/python' | 'errors/default';
+export type ErrorsCatcherType = 'errors/javascript' | 'errors/php' | 'errors/nodejs' | 'errors/go' | 'errors/python' | 'errors/default';
 /**
  * Type that represents all supported Catcher message types for performance
  */
-export declare type MetricsCatcherType = 'performance';
+export type MetricsCatcherType = 'performance';
 /**
  * Union type that represents all supported Catcher message types
  */
-export declare type CatcherMessageType = ErrorsCatcherType | MetricsCatcherType;
+export type CatcherMessageType = ErrorsCatcherType | MetricsCatcherType;
 /**
  * Type that represents the payload of a Catcher message based on its type
  */
-export declare type CatcherMessagePayload<Type extends CatcherMessageType> = {
+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];
 /**
  * Interface that represents a message sent by a Catcher
@@ -47,7 +68,7 @@ export interface CatcherMessage<Type extends CatcherMessageType> {
  * Type that represents a Catcher message accepted by the collector
  * It omits the token field and adds projectId and timestamp
  */
-export declare type CatcherMessageAccepted<Type extends CatcherMessageType> = Omit<CatcherMessage<Type>, 'token'> & {
+export type CatcherMessageAccepted<Type extends CatcherMessageType> = Omit<CatcherMessage<Type>, 'token'> & {
     /**
      * Id of the project that sent the message
      */

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

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

package/build/src/dbScheme/groupedEvent.d.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
  */
@@ -55,14 +55,20 @@ export interface GroupedEventDBScheme {
     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 {
+    /**
+     * 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 {
+    /**
+     * Event data where 'context' and 'addons' are json strings
+     */
     payload: EncodedEventData;
 }

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

@@ -1,4 +1,4 @@
-import { ObjectId } from "mongodb";
+import type { ObjectId } from 'bson';
 /**
  * Represents confirmed member info in DB
  */
@@ -32,4 +32,4 @@ export interface PendingMemberDBScheme {
 /**
  * Represents full structure of team collection documents
  */
-export declare type MemberDBScheme = ConfirmedMemberDBScheme | PendingMemberDBScheme;
+export type MemberDBScheme = ConfirmedMemberDBScheme | PendingMemberDBScheme;

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

@@ -1,4 +1,4 @@
-import { NotificationsChannelSettingsDBScheme } from "../../index";
+import type { NotificationsChannelSettingsDBScheme } from '../../index.ts';
 /**
  * Available channels
  */

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

@@ -1,4 +1,4 @@
-import { ObjectId } from "mongodb";
+import type { ObjectId } from 'bson';
 /**
  * Plan representation in DataBase
  */

package/build/src/dbScheme/project.d.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
  */
@@ -11,7 +11,6 @@ export interface ProjectDBScheme {
     _id: ObjectId;
     /**
      * Unique integration id, that's used as collector domain url for sending events
-     *
      * @example `wss://${integrationId}.k1.hawk.so/ws`
      */
     integrationId: string;

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

@@ -1,4 +1,8 @@
-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

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

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

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

@@ -1,30 +1,26 @@
-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
  */
 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;
@@ -43,7 +39,6 @@ export interface ReleaseDBScheme {
     projectId: string;
     /**
      * Release name
-     *
      * @example Version 1.0
      */
     release: string;

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

@@ -1,6 +1,9 @@
-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
@@ -11,7 +14,7 @@ export interface RepetitionDBScheme {
      */
     groupHash: string;
     /**
-     * @deprecated, use delta instead
+     * @deprecated use delta instead
      * And any of EventData field with diff
      * except fields that used in groupHash
      */
@@ -31,11 +34,17 @@ export interface RepetitionDBScheme {
  * Repetition with decoded event data
  */
 export interface DecodedRepetition {
+    /**
+     * Event data where 'context' and 'addons' are objects
+     */
     payload: DecodedEventData<EventAddons>;
 }
 /**
  * Repetition with decoded event data
  */
 export interface EncodedRepetition {
+    /**
+     * Event data where 'context' and 'addons' are json strings
+     */
     payload: EncodedEventData;
 }

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

@@ -1,17 +1,15 @@
-import { ObjectID, Timestamp } from 'mongodb';
+import type { ObjectId, Timestamp } from 'bson';
 /**
  * Source map with parsed file names, stored in the release
  */
 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;
@@ -23,18 +21,17 @@ 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
      */
@@ -45,7 +42,6 @@ export interface SourceMapFileChunk {
     chunkSize: number;
     /**
      * Uploading date  stored as a BSON datetime value 'Timestamp'.
-     *
      * @example 2020-02-18T14:51:40.400Z
      */
     uploadDate: Timestamp;