@hawk.so/types 0.1.36 → 0.1.38

package/build/index.d.ts

@@ -3,6 +3,7 @@ export * from "./src/base/businessOperation/businessOperation";
 export * from "./src/billing/planProlongrationPayload";
 export * from "./src/base/event/affectedUser";
 export * from "./src/base/event/backtraceFrame";
+export * from "./src/base/event/breadcrumb";
 export * from "./src/base/event/event";
 export * from "./src/base/event/sourceCodeLine";
 export * from "./src/base/event/addons";

package/build/index.js

@@ -15,6 +15,7 @@ __exportStar(require("./src/base/businessOperation/businessOperation"), exports)
 __exportStar(require("./src/billing/planProlongrationPayload"), exports);
 __exportStar(require("./src/base/event/affectedUser"), exports);
 __exportStar(require("./src/base/event/backtraceFrame"), exports);
+__exportStar(require("./src/base/event/breadcrumb"), exports);
 __exportStar(require("./src/base/event/event"), exports);
 __exportStar(require("./src/base/event/sourceCodeLine"), exports);
 __exportStar(require("./src/base/event/addons"), exports);

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

@@ -0,0 +1,59 @@
+import { Json } from '../../utils';
+/**
+ * Breadcrumb severity level
+ */
+export declare 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';
+/**
+ * Single breadcrumb entry - represents an event that occurred before the error
+ */
+export interface Breadcrumb {
+    /**
+     * Timestamp when the breadcrumb occurred
+     * Unix timestamp in milliseconds since epoch (e.g., 1701867896789)
+     *
+     * Note: This field uses milliseconds format
+     *
+     * @example 1701867896789
+     */
+    timestamp: number;
+    /**
+     * Type of breadcrumb - controls UI categorization
+     */
+    type?: BreadcrumbType;
+    /**
+     * Category of the event - more specific than type, provides detailed classification
+     *
+     * Examples:
+     * - For type='ui': "ui.click", "ui.scroll", "ui.mousemove"
+     * - 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"
+     */
+    category?: string;
+    /**
+     * Human-readable message describing the event
+     *
+     * @example "GET /api/profile 200"
+     * @example "Click on button#submit"
+     * @example "Navigated to /dashboard"
+     * @example "User logged in"
+     */
+    message?: string;
+    /**
+     * Severity level of the breadcrumb
+     */
+    level?: BreadcrumbLevel;
+    /**
+     * Arbitrary key-value data associated with the breadcrumb
+     */
+    data?: Record<string, Json>;
+}

package/build/src/base/event/breadcrumb.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,6 +1,7 @@
 import { BacktraceFrame } from './backtraceFrame';
 import { AffectedUser } from './affectedUser';
 import { EventAddons } from './addons';
+import { Breadcrumb } from './breadcrumb';
 import { Json } from '../../utils';
 /**
  * Information about event (Payload of the event)
@@ -28,6 +29,10 @@ 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
      */

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

@@ -23,4 +23,8 @@ export interface NotificationsChannelsDBScheme {
      * Pushes through the Hawk Desktop app
      */
     desktopPush?: NotificationsChannelSettingsDBScheme;
+    /**
+     * Alerts through the Loop
+     */
+    loop?: NotificationsChannelSettingsDBScheme;
 }

package/index.ts

@@ -6,6 +6,7 @@ export * from "./src/billing/planProlongrationPayload";
 
 export * from "./src/base/event/affectedUser";
 export * from "./src/base/event/backtraceFrame";
+export * from "./src/base/event/breadcrumb";
 export * from "./src/base/event/event";
 export * from "./src/base/event/sourceCodeLine";
 export * from "./src/base/event/addons";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hawk.so/types",
-  "version": "0.1.36",
+  "version": "0.1.38",
   "description": "TypeScript definitions for Hawk",
   "types": "build/index.d.ts",
   "main": "build/index.js",

package/src/base/event/breadcrumb.ts

@@ -0,0 +1,74 @@
+import { Json } from '../../utils';
+
+/**
+ * Breadcrumb severity level
+ */
+export type BreadcrumbLevel = 'fatal' | 'error' | 'warning' | 'info' | 'debug';
+
+/**
+ * Breadcrumb type - controls categorization and UI appearance
+ * Common types suitable for both client and backend
+ */
+export type BreadcrumbType =
+  | 'default'
+  | '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
+
+/**
+ * Single breadcrumb entry - represents an event that occurred before the error
+ */
+export interface Breadcrumb {
+  /**
+   * Timestamp when the breadcrumb occurred
+   * Unix timestamp in milliseconds since epoch (e.g., 1701867896789)
+   *
+   * Note: This field uses milliseconds format
+   *
+   * @example 1701867896789
+   */
+  timestamp: number;
+
+  /**
+   * Type of breadcrumb - controls UI categorization
+   */
+  type?: BreadcrumbType;
+
+  /**
+   * Category of the event - more specific than type, provides detailed classification
+   *
+   * Examples:
+   * - For type='ui': "ui.click", "ui.scroll", "ui.mousemove"
+   * - 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"
+   */
+  category?: string;
+
+  /**
+   * Human-readable message describing the event
+   *
+   * @example "GET /api/profile 200"
+   * @example "Click on button#submit"
+   * @example "Navigated to /dashboard"
+   * @example "User logged in"
+   */
+  message?: string;
+
+  /**
+   * Severity level of the breadcrumb
+   */
+  level?: BreadcrumbLevel;
+
+  /**
+   * Arbitrary key-value data associated with the breadcrumb
+   */
+  data?: Record<string, Json>;
+}
+

package/src/base/event/event.ts

@@ -1,6 +1,7 @@
 import { BacktraceFrame } from './backtraceFrame';
 import { AffectedUser } from './affectedUser';
 import { EventAddons } from './addons';
+import { Breadcrumb } from './breadcrumb';
 import { Json } from '../../utils';
 
 /**
@@ -34,6 +35,11 @@ export interface EventData<Addons extends EventAddons> {
      */
     release?: string;
 
+    /**
+     * Breadcrumbs - chronological trail of events before the error
+     */
+    breadcrumbs?: Breadcrumb[];
+
     /**
      * Current authenticated user
      */

package/src/dbScheme/notificationsChannels.ts

@@ -28,4 +28,9 @@ export interface NotificationsChannelsDBScheme {
      * Pushes through the Hawk Desktop app
      */
     desktopPush?: NotificationsChannelSettingsDBScheme;
+
+    /**
+     * Alerts through the Loop
+     */
+    loop?: NotificationsChannelSettingsDBScheme;
 }