@offnominal/ndb2-api-types 0.2.2

package/README.md

@@ -0,0 +1,28 @@
+The package is currently in beta.
+
+# NDB2 API Types
+
+This package provides endpoint, entities, and other response types for the private [NDB2 API](https://github.com/Off-Nominal/ndb2) version 2 and later. You probably don't need this package but feel free to look around if you're super curious and bored.
+
+## Installation
+
+`npm install @offnominal/ndb2-api-types`
+
+## Usage
+
+API Versions will be appended to the import string. Currently only `v2` is planned.
+
+```ts
+import API from "@offnominal/ndb2-api-types/v2";
+```
+
+### Subtypes
+
+The following types are available namespaced under your import value.
+
+- Endpoints - Specific responses from each endpoint
+- Entities - Data only types, which are wrapped in response objects for Endpoints
+- Utils - Response Wrapper types
+- Errors - Error Code enum for different error values you may receive
+
+- Note, `Errors` is an enum, and therefore a value. This means you must import your types as a value and not a type.

package/dist/v2/endpoints/index.d.ts

@@ -0,0 +1,3 @@
+import * as Predictions from "./predictions";
+import * as Seasons from "./seasons";
+export { Predictions, Seasons };

package/dist/v2/endpoints/index.js

@@ -0,0 +1,41 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = 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];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Seasons = exports.Predictions = void 0;
+const Predictions = __importStar(require("./predictions"));
+exports.Predictions = Predictions;
+const Seasons = __importStar(require("./seasons"));
+exports.Seasons = Seasons;
+//# sourceMappingURL=index.js.map

package/dist/v2/endpoints/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/v2/endpoints/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2DAA6C;AAGpC,kCAAW;AAFpB,mDAAqC;AAEf,0BAAO"}

package/dist/v2/endpoints/predictions.d.ts

@@ -0,0 +1,10 @@
+import { Entities } from "..";
+import { APIResponse } from "../utils";
+export declare namespace GET_ById {
+    type Data = Entities.Predictions.Prediction;
+    type Response = APIResponse<Data>;
+}
+export declare namespace DELETE_ById_trigger {
+    type Data = null;
+    type Response = APIResponse<Data>;
+}

package/dist/v2/endpoints/predictions.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=predictions.js.map

package/dist/v2/endpoints/predictions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"predictions.js","sourceRoot":"","sources":["../../../src/v2/endpoints/predictions.ts"],"names":[],"mappings":""}

package/dist/v2/endpoints/seasons.d.ts

@@ -0,0 +1,6 @@
+import { Entities } from "..";
+import { APIResponse } from "../utils";
+export declare namespace GET {
+    type Data = Entities.Seasons.Season[];
+    type Response = APIResponse<Data>;
+}

package/dist/v2/endpoints/seasons.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=seasons.js.map

package/dist/v2/endpoints/seasons.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"seasons.js","sourceRoot":"","sources":["../../../src/v2/endpoints/seasons.ts"],"names":[],"mappings":""}

package/dist/v2/entities/index.d.ts

@@ -0,0 +1,3 @@
+import * as Predictions from "./predictions";
+import * as Seasons from "./seasons";
+export { Predictions, Seasons };

package/dist/v2/entities/index.js

@@ -0,0 +1,41 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = 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];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Seasons = exports.Predictions = void 0;
+const Predictions = __importStar(require("./predictions"));
+exports.Predictions = Predictions;
+const Seasons = __importStar(require("./seasons"));
+exports.Seasons = Seasons;
+//# sourceMappingURL=index.js.map

package/dist/v2/entities/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/v2/entities/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2DAA6C;AAGpC,kCAAW;AAFpB,mDAAqC;AAEf,0BAAO"}

package/dist/v2/entities/predictions.d.ts

@@ -0,0 +1,65 @@
+export type PredictionDriver = "event" | "date";
+export type PredictionLifeCycle = "checking" | "closed" | "failed" | "open" | "retired" | "successful";
+export type Prediction = {
+    id: number;
+    predictor: {
+        id: string;
+        discord_id: string;
+    };
+    text: string;
+    driver: PredictionDriver;
+    season_id: number | null;
+    season_applicable: boolean;
+    created_date: Date;
+    due_date: Date | null;
+    check_date: Date | null;
+    last_check_date: Date | null;
+    closed_date: Date | null;
+    triggered_date: Date | null;
+    triggerer: {
+        id: string;
+        discord_id: string;
+    } | null;
+    judged_date: Date | null;
+    retired_date: Date | null;
+    status: PredictionLifeCycle;
+    bets: {
+        id: number;
+        endorsed: boolean;
+        date: Date;
+        wager: number;
+        valid: boolean;
+        payout: number | null;
+        season_payout: number | null;
+        better: {
+            id: string;
+            discord_id: string;
+        };
+    }[];
+    votes: {
+        id: number;
+        vote: boolean;
+        voted_date: Date;
+        voter: {
+            id: string;
+            discord_id: string;
+        };
+    }[];
+    checks: {
+        id: number;
+        check_date: Date;
+        closed: boolean;
+        closed_at: Date | null;
+        votes: {
+            day: number;
+            week: number;
+            month: number;
+            quarter: number;
+            year: number;
+        };
+    }[];
+    payouts: {
+        endorse: number;
+        undorse: number;
+    };
+};

package/dist/v2/entities/predictions.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=predictions.js.map

package/dist/v2/entities/predictions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"predictions.js","sourceRoot":"","sources":["../../../src/v2/entities/predictions.ts"],"names":[],"mappings":""}

package/dist/v2/entities/seasons.d.ts

@@ -0,0 +1,10 @@
+export type Identifier = "current" | "past" | "future";
+export type Season = {
+    id: number;
+    name: string;
+    start: string;
+    end: string;
+    wager_cap: number;
+    closed: boolean;
+    identifier: Identifier;
+};

package/dist/v2/entities/seasons.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=seasons.js.map

package/dist/v2/entities/seasons.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"seasons.js","sourceRoot":"","sources":["../../../src/v2/entities/seasons.ts"],"names":[],"mappings":""}

package/dist/v2/errors.d.ts

@@ -0,0 +1,12 @@
+export declare const Errors: {
+    readonly SERVER_ERROR: 90000;
+    readonly MALFORMED_BODY_DATA: 90001;
+    readonly MALFORMED_QUERY_PARAMS: 90002;
+    readonly MALFORMED_URL_PARAMS: 90003;
+    readonly PREDICTION_NOT_FOUND: 90200;
+    readonly INVALID_PREDICTION_STATUS: 90201;
+    readonly INVALID_CHECK_DATE: 90202;
+    readonly BETS_NO_CHANGE: 90501;
+    readonly BETS_UNCHANGEABLE: 90502;
+};
+export type NDB2APIError = (typeof Errors)[keyof typeof Errors];

package/dist/v2/errors.js

@@ -0,0 +1,34 @@
+"use strict";
+// Error Legend
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Errors = void 0;
+// First digit - 9
+// Digits 1 and 2 - Resource
+// Digits 3 and 4 - Error Code
+// Resources
+// 00 - Generic
+// 01 - Users
+// 02 - Predictions
+// 03 - Scores
+// 04 - Seasons
+// 05 - Bets
+// 06 - Votes
+exports.Errors = {
+    // Basic Errors
+    SERVER_ERROR: 90000,
+    MALFORMED_BODY_DATA: 90001,
+    MALFORMED_QUERY_PARAMS: 90002,
+    MALFORMED_URL_PARAMS: 90003,
+    // 01 Users
+    // 02 Predictions
+    PREDICTION_NOT_FOUND: 90200,
+    INVALID_PREDICTION_STATUS: 90201,
+    INVALID_CHECK_DATE: 90202,
+    // 03 Scores
+    // 04 Seasons
+    // 05 Bets
+    BETS_NO_CHANGE: 90501,
+    BETS_UNCHANGEABLE: 90502,
+    // 06 Votes
+};
+//# sourceMappingURL=errors.js.map

package/dist/v2/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/v2/errors.ts"],"names":[],"mappings":";AAAA,eAAe;;;AAEf,kBAAkB;AAClB,4BAA4B;AAC5B,8BAA8B;AAE9B,YAAY;AACZ,eAAe;AACf,aAAa;AACb,mBAAmB;AACnB,cAAc;AACd,eAAe;AACf,YAAY;AACZ,aAAa;AAEA,QAAA,MAAM,GAAG;IACpB,eAAe;IACf,YAAY,EAAE,KAAK;IACnB,mBAAmB,EAAE,KAAK;IAC1B,sBAAsB,EAAE,KAAK;IAC7B,oBAAoB,EAAE,KAAK;IAE3B,WAAW;IAEX,iBAAiB;IACjB,oBAAoB,EAAE,KAAK;IAC3B,yBAAyB,EAAE,KAAK;IAChC,kBAAkB,EAAE,KAAK;IAEzB,YAAY;IAEZ,aAAa;IAEb,UAAU;IACV,cAAc,EAAE,KAAK;IACrB,iBAAiB,EAAE,KAAK;IAExB,WAAW;CACH,CAAC"}

package/dist/v2/index.d.ts

@@ -0,0 +1,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 };

package/dist/v2/index.js

@@ -0,0 +1,45 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = 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];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Utils = exports.Errors = exports.Endpoints = exports.Entities = void 0;
+const Entities = __importStar(require("./entities"));
+exports.Entities = Entities;
+const Endpoints = __importStar(require("./endpoints"));
+exports.Endpoints = Endpoints;
+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;
+//# sourceMappingURL=index.js.map

package/dist/v2/index.js.map

@@ -0,0 +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"}

package/dist/v2/utils.d.ts

@@ -0,0 +1,16 @@
+import { NDB2APIError } from "./errors";
+export type SuccessResponse<T> = {
+    success: true;
+    message: string | null;
+    data: T;
+};
+export type ErrorInfo = {
+    code: NDB2APIError;
+    message: string;
+};
+export type ErrorResponse = {
+    success: false;
+    errors: ErrorInfo[];
+    data: null;
+};
+export type APIResponse<T> = SuccessResponse<T> | ErrorResponse;

package/dist/v2/utils.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=utils.js.map

package/dist/v2/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/v2/utils.ts"],"names":[],"mappings":""}

package/dist/v2/webhooks/index.d.ts

@@ -0,0 +1,10 @@
+import { Entities } from "..";
+type BaseWebhookPayload = {
+    event_id: string;
+    emitted_at: string;
+};
+export type UntriggeredPrediction = BaseWebhookPayload & {
+    event: "untriggered_prediction";
+    data: Entities.Predictions.Prediction;
+};
+export {};

package/dist/v2/webhooks/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/v2/webhooks/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/v2/webhooks/index.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@offnominal/ndb2-api-types",
+  "version": "0.2.2",
+  "author": "Jake Robins",
+  "types": "./src/v2/index.ts",
+  "main": "./dist/v2/index.js",
+  "exports": {
+    "./v2": {
+      "types": "./src/v2/index.ts",
+      "default": "./dist/v2/index.js",
+      "source": "./src/v2/index.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "clear": "rm -rf ./dist",
+    "compile": "pnpm run clear && pnpm run build && node ./dist/index.js",
+    "dev": "NODE_ENV=dev nodemon --exec \"pnpm run build\"",
+    "prepublishOnly": "npm run build"
+  },
+  "devDependencies": {
+    "nodemon": "^3.1.10",
+    "typescript": "^5.8.3"
+  },
+  "license": "ISC",
+  "description": "Typescript Types for NDB2 API",
+  "homepage": "https://github.com/mendahu/ndb2#readme"
+}

package/src/v2/endpoints/index.ts

@@ -0,0 +1,4 @@
+import * as Predictions from "./predictions";
+import * as Seasons from "./seasons";
+
+export { Predictions, Seasons };

package/src/v2/endpoints/predictions.ts

@@ -0,0 +1,14 @@
+import { Entities } from "..";
+import { APIResponse } from "../utils";
+
+// GET /predictions/{prediction_id}/
+export namespace GET_ById {
+  export type Data = Entities.Predictions.Prediction;
+  export type Response = APIResponse<Data>;
+}
+
+// DELETE /predictions/{prediction_id}/trigger
+export namespace DELETE_ById_trigger {
+  export type Data = null;
+  export type Response = APIResponse<Data>;
+}

package/src/v2/endpoints/seasons.ts

@@ -0,0 +1,8 @@
+import { Entities } from "..";
+import { APIResponse } from "../utils";
+
+// GET /seasons/
+export namespace GET {
+  export type Data = Entities.Seasons.Season[];
+  export type Response = APIResponse<Data>;
+}

package/src/v2/entities/index.ts

@@ -0,0 +1,4 @@
+import * as Predictions from "./predictions";
+import * as Seasons from "./seasons";
+
+export { Predictions, Seasons };

package/src/v2/entities/predictions.ts

@@ -0,0 +1,73 @@
+export type PredictionDriver = "event" | "date";
+
+export type PredictionLifeCycle =
+  | "checking"
+  | "closed"
+  | "failed"
+  | "open"
+  | "retired"
+  | "successful";
+
+export type Prediction = {
+  id: number;
+  predictor: {
+    id: string;
+    discord_id: string;
+  };
+  text: string;
+  driver: PredictionDriver;
+  season_id: number | null;
+  season_applicable: boolean;
+  created_date: Date;
+  due_date: Date | null;
+  check_date: Date | null;
+  last_check_date: Date | null;
+  closed_date: Date | null;
+  triggered_date: Date | null;
+  triggerer: {
+    id: string;
+    discord_id: string;
+  } | null;
+  judged_date: Date | null;
+  retired_date: Date | null;
+  status: PredictionLifeCycle;
+  bets: {
+    id: number;
+    endorsed: boolean;
+    date: Date;
+    wager: number;
+    valid: boolean;
+    payout: number | null;
+    season_payout: number | null;
+    better: {
+      id: string;
+      discord_id: string;
+    };
+  }[];
+  votes: {
+    id: number;
+    vote: boolean;
+    voted_date: Date;
+    voter: {
+      id: string;
+      discord_id: string;
+    };
+  }[];
+  checks: {
+    id: number;
+    check_date: Date;
+    closed: boolean;
+    closed_at: Date | null;
+    votes: {
+      day: number;
+      week: number;
+      month: number;
+      quarter: number;
+      year: number;
+    };
+  }[];
+  payouts: {
+    endorse: number;
+    undorse: number;
+  };
+};

package/src/v2/entities/seasons.ts

@@ -0,0 +1,11 @@
+export type Identifier = "current" | "past" | "future";
+
+export type Season = {
+  id: number;
+  name: string;
+  start: string;
+  end: string;
+  wager_cap: number;
+  closed: boolean;
+  identifier: Identifier;
+};

package/src/v2/errors.ts

@@ -0,0 +1,41 @@
+// Error Legend
+
+// First digit - 9
+// Digits 1 and 2 - Resource
+// Digits 3 and 4 - Error Code
+
+// Resources
+// 00 - Generic
+// 01 - Users
+// 02 - Predictions
+// 03 - Scores
+// 04 - Seasons
+// 05 - Bets
+// 06 - Votes
+
+export const Errors = {
+  // Basic Errors
+  SERVER_ERROR: 90000,
+  MALFORMED_BODY_DATA: 90001,
+  MALFORMED_QUERY_PARAMS: 90002,
+  MALFORMED_URL_PARAMS: 90003,
+
+  // 01 Users
+
+  // 02 Predictions
+  PREDICTION_NOT_FOUND: 90200,
+  INVALID_PREDICTION_STATUS: 90201,
+  INVALID_CHECK_DATE: 90202,
+
+  // 03 Scores
+
+  // 04 Seasons
+
+  // 05 Bets
+  BETS_NO_CHANGE: 90501,
+  BETS_UNCHANGEABLE: 90502,
+
+  // 06 Votes
+} as const;
+
+export type NDB2APIError = (typeof Errors)[keyof typeof Errors];

package/src/v2/index.ts

@@ -0,0 +1,6 @@
+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 };

package/src/v2/utils.ts

@@ -0,0 +1,20 @@
+import { NDB2APIError } from "./errors";
+
+export type SuccessResponse<T> = {
+  success: true;
+  message: string | null;
+  data: T;
+};
+
+export type ErrorInfo = {
+  code: NDB2APIError;
+  message: string;
+};
+
+export type ErrorResponse = {
+  success: false;
+  errors: ErrorInfo[];
+  data: null;
+};
+
+export type APIResponse<T> = SuccessResponse<T> | ErrorResponse;