@hawk.so/types 0.1.13 → 0.1.17

package/build/index.d.ts

@@ -26,4 +26,5 @@ export * from "./src/notifications/createProjectNotifications";
 export * from "./src/notifications/receiveTypes";
 export * from "./src/notifications/updateProjectNotifications";
 export * from "./src/notifications/userNotification";
+export * from "./src/catchers/catcher-message";
 export * from './src/utils';

package/build/index.js

@@ -38,4 +38,5 @@ __exportStar(require("./src/notifications/createProjectNotifications"), exports)
 __exportStar(require("./src/notifications/receiveTypes"), exports);
 __exportStar(require("./src/notifications/updateProjectNotifications"), exports);
 __exportStar(require("./src/notifications/userNotification"), exports);
+__exportStar(require("./src/catchers/catcher-message"), exports);
 __exportStar(require("./src/utils"), exports);

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

@@ -0,0 +1,5 @@
+/**
+ * This interface represents data that can be additionally collected by Default Catcher
+ */
+export interface DefaultAddons {
+}

package/build/src/base/event/addons/default.js

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

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

@@ -3,8 +3,9 @@ import { PhpAddons } from './php';
 import { NodeJSAddons } from './nodejs';
 import { GoAddons } from './go';
 import { PythonAddons } from './python';
+import { DefaultAddons } from './default';
 /**
  * Union Type describing all catcher-specific additional data
  */
-declare type EventAddons = JavaScriptAddons | PhpAddons | NodeJSAddons | GoAddons | PythonAddons;
-export { WindowData, VueIntegrationAddons, BeautifiedUserAgent, EventAddons, JavaScriptAddons, PhpAddons, NodeJSAddons, GoAddons, PythonAddons };
+declare type EventAddons = JavaScriptAddons | PhpAddons | NodeJSAddons | GoAddons | PythonAddons | DefaultAddons;
+export { WindowData, VueIntegrationAddons, BeautifiedUserAgent, EventAddons, JavaScriptAddons, PhpAddons, NodeJSAddons, GoAddons, PythonAddons, DefaultAddons };

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

@@ -0,0 +1,19 @@
+import { EventData } from "../base/event/event";
+import { EventAddons } from "../base/event/addons";
+/**
+ * Structure describing a message sending by Catcher
+ */
+export default interface CatcherMessage<CatcherAddons extends EventAddons> {
+    /**
+     * User project's Integration Token
+     */
+    token: string;
+    /**
+     * Hawk Catcher name
+     */
+    catcherType: string;
+    /**
+     * All information about the event
+     */
+    payload: EventData<CatcherAddons>;
+}

package/build/src/catchers/catcher-message.js

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

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

@@ -23,4 +23,9 @@ export interface PlanDBScheme {
      * Is this plan used by default?
      */
     isDefault: boolean;
+    /**
+     * Special plans to be selected manually
+     * No one cannot be switched to this plan by api
+     */
+    isHidden: boolean;
 }

package/index.ts

@@ -33,4 +33,6 @@ export * from "./src/notifications/receiveTypes";
 export * from "./src/notifications/updateProjectNotifications";
 export * from "./src/notifications/userNotification";
 
+export * from "./src/catchers/catcher-message";
+
 export * from './src/utils';

package/package.json

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

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

@@ -0,0 +1,4 @@
+/**
+ * This interface represents data that can be additionally collected by Default Catcher
+ */
+export interface DefaultAddons {}

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

@@ -3,6 +3,7 @@ import { PhpAddons } from './php';
 import { NodeJSAddons } from './nodejs';
 import { GoAddons } from './go';
 import { PythonAddons } from './python';
+import { DefaultAddons } from './default';
 
 /**
  * Union Type describing all catcher-specific additional data
@@ -13,6 +14,7 @@ type EventAddons =
   | NodeJSAddons
   | GoAddons
   | PythonAddons
+  | DefaultAddons
 ;
 
 export {
@@ -24,5 +26,6 @@ export {
   PhpAddons,
   NodeJSAddons,
   GoAddons,
-  PythonAddons
+  PythonAddons,
+  DefaultAddons
 }

package/src/catchers/catcher-message.ts

@@ -0,0 +1,22 @@
+import { EventData } from "../base/event/event";
+import { EventAddons } from "../base/event/addons";
+
+/**
+ * Structure describing a message sending by Catcher
+ */
+export default interface CatcherMessage<CatcherAddons extends EventAddons> {
+  /**
+   * User project's Integration Token
+   */
+  token: string;
+
+  /**
+   * Hawk Catcher name
+   */
+  catcherType: string;
+
+  /**
+   * All information about the event
+   */
+  payload: EventData<CatcherAddons>;
+}

package/src/dbScheme/plan.ts

@@ -28,4 +28,10 @@ export interface PlanDBScheme {
      * Is this plan used by default?
      */
     isDefault: boolean;
+
+    /**
+     * Special plans to be selected manually
+     * No one cannot be switched to this plan by api
+     */
+    isHidden: boolean;
 }