@pluto-khronos/types 0.1.0

package/dist/schemas/channels.js

@@ -0,0 +1,141 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.incomingChannelDataSchema = exports.channelCreationEventSchema = exports.channelEligibleGuildSchema = exports.prepareMatchEmbedSchema = exports.channelAggregatedSchema = exports.channelDeletionEventSchema = exports.channelDeletionResultSchema = exports.channelDeletionJobSchema = void 0;
+/**
+ * @group Channels
+ * Schemas for managing Discord channel-related operations
+ */
+const zod_1 = require("zod");
+const betting_1 = require("./betting");
+const colors_1 = require("./colors");
+const guilds_1 = require("./guilds");
+const match_metadata_1 = require("./match-metadata");
+const shared_1 = require("./shared");
+const sports_1 = require("./sports");
+const teams_1 = require("./teams");
+/**
+ * Schema for channel deletion job data
+ * @group Channel Deletion
+ */
+exports.channelDeletionJobSchema = zod_1.z
+    .object({
+    channelName: zod_1.z.string().describe('Name of the channel to be deleted'),
+    jobId: zod_1.z
+        .string()
+        .optional()
+        .describe('Optional unique identifier for the deletion job'),
+})
+    .describe('BullMQ Schema structure for channel deletion jobs');
+/**
+ * Schema for channel deletion operation results
+ * @group Channel Deletion
+ */
+exports.channelDeletionResultSchema = zod_1.z
+    .object({
+    success: zod_1.z
+        .boolean()
+        .describe('Whether the deletion operation was successful'),
+    channelName: zod_1.z.string().describe('Name of the channel that was processed'),
+    error: zod_1.z.string().optional().describe('Error message if deletion failed'),
+})
+    .describe('BullMQ Schema structure for channel deletion results');
+/**
+ * Schema for channel deletion event data
+ * @group Channel Deletion
+ */
+exports.channelDeletionEventSchema = zod_1.z
+    .object({
+    channelIds: zod_1.z
+        .array(zod_1.z.string())
+        .describe('Array of channel IDs to be deleted from Discord'),
+    metadata: zod_1.z
+        .object({
+        publishedAt: zod_1.z
+            .date()
+            .describe('Timestamp when the deletion event was published'),
+        eventId: zod_1.z
+            .string()
+            .describe('Unique identifier for tracking the deletion event'),
+    })
+        .describe('Metadata associated with the channel deletion event'),
+})
+    .describe('BullMQ Schema structure for channel deletion events data');
+/**
+ * Schema for aggregated channel information
+ * @group Channel Data
+ */
+exports.channelAggregatedSchema = zod_1.z
+    .object({
+    id: zod_1.z.string().describe('Unique identifier for the channel'),
+    sport: sports_1.sportsServingSchema,
+    created: zod_1.z
+        .boolean()
+        .describe('Whether the channel has been created in Discord'),
+    gametime: zod_1.z.date().describe('Scheduled time for the game/match'),
+    channelname: zod_1.z.string().describe('Name of the Discord channel'),
+    matchOdds: betting_1.matchOddsSchema,
+    ...teams_1.matchTeamsSchema.shape,
+    metadata: match_metadata_1.matchMetadataSchema.optional(),
+})
+    .describe('Aggregated channel information including match and odds details');
+/**
+ * Schema for match embed preparation data
+ * @group Channel Embeds
+ */
+exports.prepareMatchEmbedSchema = zod_1.z
+    .object({
+    favored: zod_1.z.string().describe('Team favored to win'),
+    favoredTeamClr: colors_1.colorResolvableSchema.describe('Color for the favored team'),
+    home_team: zod_1.z.string().describe('Full name of home team'),
+    homeTeamShortName: zod_1.z
+        .string()
+        .describe('Short name/abbreviation of home team'),
+    away_team: zod_1.z.string().describe('Full name of away team'),
+    awayTeamShortName: zod_1.z
+        .string()
+        .describe('Short name/abbreviation of away team'),
+    bettingChanId: zod_1.z.string().describe('ID of the betting channel'),
+    header: zod_1.z.string().describe('Header text for the match embed'),
+    sport: sports_1.sportsServingSchema.describe('Sport type for the match'),
+    records: sports_1.teamRecordsResultSchema
+        .nullable()
+        .optional()
+        .describe('Optional team records'),
+})
+    .describe('Data structure for preparing match embed messages');
+/**
+ * Schema for guild data with channel creation eligibility
+ * @group Guilds
+ */
+exports.channelEligibleGuildSchema = guilds_1.guildConfigSchema
+    .extend({
+    eligibleMatches: zod_1.z
+        .array(zod_1.z.string())
+        .describe('List of match IDs eligible for channel creation'),
+})
+    .describe('Guild data for channel creation eligibility');
+/**
+ * Schema for channel creation events
+ * @group Channel Creation
+ */
+exports.channelCreationEventSchema = zod_1.z
+    .object({
+    channel: exports.channelAggregatedSchema,
+    guild: exports.channelEligibleGuildSchema,
+    metadata: shared_1.bullMqMetadataSchema,
+})
+    .describe('Event data for channel creation operations');
+/**
+ * Schema for incoming channel data from Pluto
+ * @group Channel Data
+ */
+exports.incomingChannelDataSchema = zod_1.z
+    .object({
+    channels: zod_1.z
+        .array(exports.channelAggregatedSchema)
+        .describe('Array of channel data'),
+    guilds: zod_1.z
+        .array(exports.channelEligibleGuildSchema)
+        .describe('Array of eligible guild data'),
+})
+    .describe('Schema for Pluto to process channel creation events');

package/dist/schemas/colors.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @group Colors
+ * Schemas for Discord color-related types and validations
+ */
+import { z } from 'zod';
+/**
+ * Schema for Discord.js color values, supporting hex, integer, and named colors
+ * @group Colors
+ */
+export declare const colorResolvableSchema: z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodEnum<["DEFAULT", "WHITE", "AQUA", "GREEN", "BLUE", "YELLOW", "PURPLE", "LUMINOUS_VIVID_PINK", "FUCHSIA", "GOLD", "ORANGE", "RED", "GREY", "NAVY", "DARK_AQUA", "DARK_GREEN", "DARK_BLUE", "DARK_PURPLE", "DARK_VIVID_PINK", "DARK_GOLD", "DARK_ORANGE", "DARK_RED", "DARK_GREY", "DARKER_GREY", "LIGHT_GREY", "DARK_NAVY", "BLURPLE", "GREYPLE", "DARK_BUT_NOT_BLACK", "NOT_QUITE_BLACK", "RANDOM"]>]>;
+/**
+ * Type representing a Discord.js color value
+ * @group Colors
+ */
+export type ColorResolvable = z.infer<typeof colorResolvableSchema>;

package/dist/schemas/colors.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.colorResolvableSchema = void 0;
+/**
+ * @group Colors
+ * Schemas for Discord color-related types and validations
+ */
+const zod_1 = require("zod");
+/**
+ * Schema for Discord.js color values, supporting hex, integer, and named colors
+ * @group Colors
+ */
+exports.colorResolvableSchema = zod_1.z
+    .union([
+    zod_1.z
+        .string()
+        .regex(/^#[0-9A-Fa-f]{6}$/)
+        .describe('Hex color code in #RRGGBB format'),
+    zod_1.z
+        .number()
+        .int()
+        .min(0)
+        .max(0xffffff)
+        .describe('Integer color value between 0 and 16777215'),
+    zod_1.z
+        .enum([
+        'DEFAULT',
+        'WHITE',
+        'AQUA',
+        'GREEN',
+        'BLUE',
+        'YELLOW',
+        'PURPLE',
+        'LUMINOUS_VIVID_PINK',
+        'FUCHSIA',
+        'GOLD',
+        'ORANGE',
+        'RED',
+        'GREY',
+        'NAVY',
+        'DARK_AQUA',
+        'DARK_GREEN',
+        'DARK_BLUE',
+        'DARK_PURPLE',
+        'DARK_VIVID_PINK',
+        'DARK_GOLD',
+        'DARK_ORANGE',
+        'DARK_RED',
+        'DARK_GREY',
+        'DARKER_GREY',
+        'LIGHT_GREY',
+        'DARK_NAVY',
+        'BLURPLE',
+        'GREYPLE',
+        'DARK_BUT_NOT_BLACK',
+        'NOT_QUITE_BLACK',
+        'RANDOM',
+    ])
+        .describe('Discord.js predefined color names'),
+])
+    .describe('Discord.js ColorResolvable - supports hex codes, integers, and predefined color names');

package/dist/schemas/guilds.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @group Guilds
+ * Schemas and types for Discord guild (server) configurations
+ */
+import { z } from 'zod';
+/**
+ * Base schema for guild configuration
+ * @group Guilds
+ */
+export declare const guildConfigSchema: z.ZodObject<{
+    guildId: z.ZodString;
+    bettingChannelId: z.ZodString;
+    gameCategoryId: z.ZodString;
+    preferredTeams: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    sport: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    guildId: string;
+    bettingChannelId: string;
+    gameCategoryId: string;
+    sport: string;
+    preferredTeams?: string[] | undefined;
+}, {
+    guildId: string;
+    bettingChannelId: string;
+    gameCategoryId: string;
+    sport: string;
+    preferredTeams?: string[] | undefined;
+}>;
+/**
+ * Type representing base guild configuration
+ * @group Guilds
+ */
+export type GuildConfig = z.infer<typeof guildConfigSchema>;

package/dist/schemas/guilds.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.guildConfigSchema = void 0;
+/**
+ * @group Guilds
+ * Schemas and types for Discord guild (server) configurations
+ */
+const zod_1 = require("zod");
+/**
+ * Base schema for guild configuration
+ * @group Guilds
+ */
+exports.guildConfigSchema = zod_1.z
+    .object({
+    guildId: zod_1.z.string().describe('Discord guild (server) ID'),
+    bettingChannelId: zod_1.z
+        .string()
+        .describe('ID of the channel where betting takes place'),
+    gameCategoryId: zod_1.z
+        .string()
+        .describe('ID of the category where game channels are created'),
+    preferredTeams: zod_1.z
+        .array(zod_1.z.string())
+        .optional()
+        .describe('List of teams the guild follows. May be an empty array if the guild follows no teams, allowing them to receive data for all events for their defined sport'),
+    sport: zod_1.z.string().describe('Sport type for this guild configuration'),
+})
+    .describe('Base Discord Guild configuration');

package/dist/schemas/match-metadata.d.ts

@@ -0,0 +1,63 @@
+/**
+ * @group Metadata
+ * Common metadata schemas used across features
+ */
+import { z } from 'zod';
+/**
+ * Schema for match metadata
+ * @group Metadata
+ */
+export declare const matchMetadataSchema: z.ZodObject<{
+    headline: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    records: z.ZodNullable<z.ZodOptional<z.ZodObject<{
+        home_team: z.ZodObject<{
+            total_record: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            total_record: string;
+        }, {
+            total_record: string;
+        }>;
+        away_team: z.ZodObject<{
+            total_record: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            total_record: string;
+        }, {
+            total_record: string;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        home_team: {
+            total_record: string;
+        };
+        away_team: {
+            total_record: string;
+        };
+    }, {
+        home_team: {
+            total_record: string;
+        };
+        away_team: {
+            total_record: string;
+        };
+    }>>>;
+}, "strip", z.ZodTypeAny, {
+    headline?: string | null | undefined;
+    records?: {
+        home_team: {
+            total_record: string;
+        };
+        away_team: {
+            total_record: string;
+        };
+    } | null | undefined;
+}, {
+    headline?: string | null | undefined;
+    records?: {
+        home_team: {
+            total_record: string;
+        };
+        away_team: {
+            total_record: string;
+        };
+    } | null | undefined;
+}>;
+export type MatchMetadata = z.infer<typeof matchMetadataSchema>;

package/dist/schemas/match-metadata.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.matchMetadataSchema = void 0;
+/**
+ * @group Metadata
+ * Common metadata schemas used across features
+ */
+const zod_1 = require("zod");
+const sports_1 = require("./sports");
+/**
+ * Schema for match metadata
+ * @group Metadata
+ */
+exports.matchMetadataSchema = zod_1.z
+    .object({
+    headline: zod_1.z.string().optional().nullable().describe('Match headline'),
+    records: sports_1.teamRecordsResultSchema
+        .optional()
+        .nullable()
+        .describe('Team records information'),
+})
+    .describe('Match metadata information');

package/dist/schemas/shared.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @group Shared
+ * Shared schemas and types used across multiple features
+ */
+import { z } from 'zod';
+/**
+ * Schema for BullMQ job metadata
+ * @group Queue
+ */
+export declare const bullMqMetadataSchema: z.ZodObject<{
+    publishedAt: z.ZodDate;
+    eventId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    publishedAt: Date;
+    eventId: string;
+}, {
+    publishedAt: Date;
+    eventId: string;
+}>;
+/**
+ * Type representing BullMQ job metadata
+ * @group Queue
+ */
+export type BullMqMetadata = z.infer<typeof bullMqMetadataSchema>;

package/dist/schemas/shared.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.bullMqMetadataSchema = void 0;
+/**
+ * @group Shared
+ * Shared schemas and types used across multiple features
+ */
+const zod_1 = require("zod");
+/**
+ * Schema for BullMQ job metadata
+ * @group Queue
+ */
+exports.bullMqMetadataSchema = zod_1.z
+    .object({
+    publishedAt: zod_1.z.date().describe('Timestamp when the event was published'),
+    eventId: zod_1.z.string().describe('Unique identifier for tracking the event'),
+})
+    .describe('Common metadata structure for BullMQ jobs');

package/dist/schemas/sports.d.ts

@@ -0,0 +1,79 @@
+/**
+ * @group Sports
+ * Schemas and types for sports-related data
+ */
+import { z } from 'zod';
+/**
+ * Constant object defining supported sports
+ * @group Sports
+ */
+export declare const SportsServing: {
+    readonly nba: "nba";
+    readonly nfl: "nfl";
+};
+/**
+ * Schema for supported sports in the application
+ * @group Sports
+ */
+export declare const sportsServingSchema: z.ZodEnum<["nba", "nfl"]>;
+/**
+ * Schema for a team's record information
+ * @group Sports
+ */
+export declare const teamRecordSchema: z.ZodObject<{
+    total_record: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    total_record: string;
+}, {
+    total_record: string;
+}>;
+/**
+ * Schema for both teams' record information in a match
+ * @group Sports
+ */
+export declare const teamRecordsResultSchema: z.ZodObject<{
+    home_team: z.ZodObject<{
+        total_record: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        total_record: string;
+    }, {
+        total_record: string;
+    }>;
+    away_team: z.ZodObject<{
+        total_record: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        total_record: string;
+    }, {
+        total_record: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    home_team: {
+        total_record: string;
+    };
+    away_team: {
+        total_record: string;
+    };
+}, {
+    home_team: {
+        total_record: string;
+    };
+    away_team: {
+        total_record: string;
+    };
+}>;
+/**
+ * Type representing a team's record
+ * @group Sports
+ */
+export type TeamRecord = z.infer<typeof teamRecordSchema>;
+/**
+ * Type representing both teams' records in a match
+
+ * @group Sports
+ */
+export type TeamRecordsResult = z.infer<typeof teamRecordsResultSchema>;
+/**
+ * Type representing the sports we support
+ * @group Sports
+ */
+export type SportsServing = z.infer<typeof sportsServingSchema>;

package/dist/schemas/sports.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.teamRecordsResultSchema = exports.teamRecordSchema = exports.sportsServingSchema = exports.SportsServing = void 0;
+/**
+ * @group Sports
+ * Schemas and types for sports-related data
+ */
+const zod_1 = require("zod");
+/**
+ * Constant object defining supported sports
+ * @group Sports
+ */
+exports.SportsServing = {
+    nba: 'nba',
+    nfl: 'nfl',
+};
+/**
+ * Schema for supported sports in the application
+ * @group Sports
+ */
+exports.sportsServingSchema = zod_1.z
+    .enum(['nba', 'nfl'])
+    .describe('Sports we support in the APIs');
+/**
+ * Schema for a team's record information
+ * @group Sports
+ */
+exports.teamRecordSchema = zod_1.z
+    .object({
+    total_record: zod_1.z.string().describe("Team's total win-loss record"),
+})
+    .describe('Team record structure');
+/**
+ * Schema for both teams' record information in a match
+ * @group Sports
+ */
+exports.teamRecordsResultSchema = zod_1.z
+    .object({
+    home_team: exports.teamRecordSchema.describe("Home team's record"),
+    away_team: exports.teamRecordSchema.describe("Away team's record"),
+})
+    .describe('Team Record information for both teams in a match');

package/dist/schemas/teams.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @group Teams
+ * Schemas for team-related data
+ */
+import { z } from 'zod';
+/**
+ * Schema for team names in a match
+ * @group Teams
+ */
+export declare const matchTeamsSchema: z.ZodObject<{
+    home_team: z.ZodString;
+    away_team: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    home_team: string;
+    away_team: string;
+}, {
+    home_team: string;
+    away_team: string;
+}>;
+/**
+ * Schema for team abbreviations
+ * @group Teams
+ */
+export declare const teamAbbreviationsSchema: z.ZodObject<{
+    homeTeamShortName: z.ZodString;
+    awayTeamShortName: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    homeTeamShortName: string;
+    awayTeamShortName: string;
+}, {
+    homeTeamShortName: string;
+    awayTeamShortName: string;
+}>;
+export type MatchTeams = z.infer<typeof matchTeamsSchema>;
+export type TeamAbbreviations = z.infer<typeof teamAbbreviationsSchema>;

package/dist/schemas/teams.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.teamAbbreviationsSchema = exports.matchTeamsSchema = void 0;
+/**
+ * @group Teams
+ * Schemas for team-related data
+ */
+const zod_1 = require("zod");
+/**
+ * Schema for team names in a match
+ * @group Teams
+ */
+exports.matchTeamsSchema = zod_1.z
+    .object({
+    home_team: zod_1.z.string().describe('Name of the home team'),
+    away_team: zod_1.z.string().describe('Name of the away team'),
+})
+    .describe('Team names in a match');
+/**
+ * Schema for team abbreviations
+ * @group Teams
+ */
+exports.teamAbbreviationsSchema = zod_1.z
+    .object({
+    homeTeamShortName: zod_1.z
+        .string()
+        .describe('Short name/abbreviation of home team'),
+    awayTeamShortName: zod_1.z
+        .string()
+        .describe('Short name/abbreviation of away team'),
+})
+    .describe('Team abbreviations');

package/dist/types.d.ts

@@ -0,0 +1 @@
+export type ColorResolvable = `#${string}` | "DEFAULT" | "WHITE" | "AQUA" | "GREEN" | "BLUE" | "YELLOW" | "PURPLE" | "LUMINOUS_VIVID_PINK" | "FUCHSIA" | "GOLD" | "ORANGE" | "RED" | "GREY" | "NAVY" | "DARK_AQUA" | "DARK_GREEN" | "DARK_BLUE" | "DARK_PURPLE" | "DARK_VIVID_PINK" | "DARK_GOLD" | "DARK_ORANGE" | "DARK_RED" | "DARK_GREY" | "DARKER_GREY" | "LIGHT_GREY" | "DARK_NAVY" | "BLURPLE" | "GREYPLE" | "DARK_BUT_NOT_BLACK" | "NOT_QUITE_BLACK" | "RANDOM" | number;

package/dist/types.js

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

package/package.json

@@ -0,0 +1,41 @@
+{
+	"name": "@pluto-khronos/types",
+	"version": "0.1.0",
+	"description": "Shared TypeScript types for Pluto & Khronos projects",
+	"main": "dist/index.js",
+	"types": "dist/index.d.ts",
+	"files": [
+		"dist"
+	],
+	"scripts": {
+		"build": "tsc",
+		"type-check": "tsc --noEmit",
+		"clean": "rm -rf dist",
+		"format": "biome check --write --unsafe .",
+		"docs": "typedoc",
+		"docs:watch": "typedoc --watch"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"keywords": [
+		"typescript",
+		"types"
+	],
+	"license": "MIT",
+	"devDependencies": {
+		"@biomejs/biome": "1.9.4",
+		"@types/bun": "^1.2.3",
+		"@types/node": "^22.13.5",
+		"lefthook": "^1.11.0",
+		"typedoc": "^0.27.8",
+		"typedoc-plugin-markdown": "^4.4.2",
+		"typedoc-plugin-mdn-links": "^4.0.14",
+		"typedoc-plugin-zod": "^1.3.1",
+		"typedoc-theme-hierarchy": "^5.0.4",
+		"typescript": "^5.0.0"
+	},
+	"dependencies": {
+		"zod": "^3.24.2"
+	}
+}