@offnominal/ndb2-api-types 0.2.4 → 0.4.0

package/dist/v2/index.d.ts

@@ -2,4 +2,5 @@ import * as Entities from "./entities";
 import * as Endpoints from "./endpoints";
 import { Errors, NDB2APIError } from "./errors";
 import * as Utils from "./utils";
-export { Entities, Endpoints, Errors, NDB2APIError, Utils };
+import * as Webhooks from "./webhooks";
+export { Entities, Endpoints, Errors, NDB2APIError, Utils, Webhooks };

package/dist/v2/index.js

@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Utils = exports.Errors = exports.Endpoints = exports.Entities = void 0;
+exports.Webhooks = exports.Utils = exports.Errors = exports.Endpoints = exports.Entities = void 0;
 const Entities = __importStar(require("./entities"));
 exports.Entities = Entities;
 const Endpoints = __importStar(require("./endpoints"));
@@ -42,4 +42,6 @@ const errors_1 = require("./errors");
 Object.defineProperty(exports, "Errors", { enumerable: true, get: function () { return errors_1.Errors; } });
 const Utils = __importStar(require("./utils"));
 exports.Utils = Utils;
+const Webhooks = __importStar(require("./webhooks"));
+exports.Webhooks = Webhooks;
 //# sourceMappingURL=index.js.map

package/dist/v2/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/v2/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qDAAuC;AAK9B,4BAAQ;AAJjB,uDAAyC;AAItB,8BAAS;AAH5B,qCAAgD;AAGlB,uFAHrB,eAAM,OAGqB;AAFpC,+CAAiC;AAEmB,sBAAK"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/v2/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qDAAuC;AAM9B,4BAAQ;AALjB,uDAAyC;AAKtB,8BAAS;AAJ5B,qCAAgD;AAIlB,uFAJrB,eAAM,OAIqB;AAHpC,+CAAiC;AAGmB,sBAAK;AAFzD,qDAAuC;AAEoB,4BAAQ"}

package/dist/v2/webhooks.d.ts

@@ -0,0 +1,20 @@
+import { Prediction } from "./entities/predictions";
+declare const WEBHOOK_EVENTS: readonly ["untriggered_prediction", "triggered_prediction"];
+export type WebhookEvent = (typeof WEBHOOK_EVENTS)[number];
+export type BasePayload<E extends WebhookEvent, D> = {
+    event_name: E;
+    version: 2;
+    date: Date;
+    data: D;
+};
+export declare namespace Events {
+    type UntriggeredPrediction = BasePayload<"untriggered_prediction", {
+        prediction: Prediction;
+    }>;
+    type TriggeredPrediction = BasePayload<"triggered_prediction", {
+        prediction: Prediction;
+    }>;
+}
+export type Payload = Events.UntriggeredPrediction | Events.TriggeredPrediction;
+export declare const isWebhookPayloadV2: (payload: any) => payload is Payload;
+export {};

package/dist/v2/webhooks.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isWebhookPayloadV2 = void 0;
+// Single source of truth for webhook events
+const WEBHOOK_EVENTS = [
+    "untriggered_prediction",
+    "triggered_prediction",
+];
+const isWebhookPayloadV2 = (payload) => {
+    if (!payload || typeof payload !== "object") {
+        return false;
+    }
+    // Validate event_name against WebhookEvent type
+    if (typeof payload.event_name !== "string" ||
+        !WEBHOOK_EVENTS.includes(payload.event_name)) {
+        return false;
+    }
+    // Validate version
+    if (payload.version !== 2) {
+        return false;
+    }
+    // Validate date (can be Date object or string that parses to valid date)
+    if (!payload.date) {
+        return false;
+    }
+    const date = payload.date instanceof Date ? payload.date : new Date(payload.date);
+    if (isNaN(date.getTime())) {
+        return false;
+    }
+    if (payload.data === undefined) {
+        return false;
+    }
+    return true;
+};
+exports.isWebhookPayloadV2 = isWebhookPayloadV2;
+//# sourceMappingURL=webhooks.js.map

package/dist/v2/webhooks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhooks.js","sourceRoot":"","sources":["../../src/v2/webhooks.ts"],"names":[],"mappings":";;;AAEA,4CAA4C;AAC5C,MAAM,cAAc,GAAG;IACrB,wBAAwB;IACxB,sBAAsB;CACd,CAAC;AA6BJ,MAAM,kBAAkB,GAAG,CAAC,OAAY,EAAsB,EAAE;IACrE,IAAI,CAAC,OAAO,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAC5C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gDAAgD;IAChD,IACE,OAAO,OAAO,CAAC,UAAU,KAAK,QAAQ;QACtC,CAAC,cAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,UAA0B,CAAC,EAC5D,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,mBAAmB;IACnB,IAAI,OAAO,CAAC,OAAO,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,yEAAyE;IACzE,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QAClB,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,IAAI,GACR,OAAO,CAAC,IAAI,YAAY,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACvE,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC/B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAjCW,QAAA,kBAAkB,sBAiC7B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@offnominal/ndb2-api-types",
-  "version": "0.2.4",
+  "version": "0.4.0",
   "author": "Jake Robins",
   "types": "./src/v2/index.ts",
   "main": "./dist/v2/index.js",

package/src/v2/index.ts

@@ -2,5 +2,6 @@ import * as Entities from "./entities";
 import * as Endpoints from "./endpoints";
 import { Errors, NDB2APIError } from "./errors";
 import * as Utils from "./utils";
+import * as Webhooks from "./webhooks";
 
-export { Entities, Endpoints, Errors, NDB2APIError, Utils };
+export { Entities, Endpoints, Errors, NDB2APIError, Utils, Webhooks };

package/src/v2/webhooks.ts

@@ -0,0 +1,69 @@
+import { Prediction } from "./entities/predictions";
+
+// Single source of truth for webhook events
+const WEBHOOK_EVENTS = [
+  "untriggered_prediction",
+  "triggered_prediction",
+] as const;
+
+// Derive the type from the array
+export type WebhookEvent = (typeof WEBHOOK_EVENTS)[number];
+
+export type BasePayload<E extends WebhookEvent, D> = {
+  event_name: E;
+  version: 2;
+  date: Date;
+  data: D;
+};
+
+export namespace Events {
+  export type UntriggeredPrediction = BasePayload<
+    "untriggered_prediction",
+    {
+      prediction: Prediction;
+    }
+  >;
+  export type TriggeredPrediction = BasePayload<
+    "triggered_prediction",
+    {
+      prediction: Prediction;
+    }
+  >;
+}
+
+export type Payload = Events.UntriggeredPrediction | Events.TriggeredPrediction;
+
+export const isWebhookPayloadV2 = (payload: any): payload is Payload => {
+  if (!payload || typeof payload !== "object") {
+    return false;
+  }
+
+  // Validate event_name against WebhookEvent type
+  if (
+    typeof payload.event_name !== "string" ||
+    !WEBHOOK_EVENTS.includes(payload.event_name as WebhookEvent)
+  ) {
+    return false;
+  }
+
+  // Validate version
+  if (payload.version !== 2) {
+    return false;
+  }
+
+  // Validate date (can be Date object or string that parses to valid date)
+  if (!payload.date) {
+    return false;
+  }
+  const date =
+    payload.date instanceof Date ? payload.date : new Date(payload.date);
+  if (isNaN(date.getTime())) {
+    return false;
+  }
+
+  if (payload.data === undefined) {
+    return false;
+  }
+
+  return true;
+};