@pluto-khronos/types 0.1.0 → 0.1.1

package/dist/schemas/channels.d.ts

@@ -1,3 +1,4 @@
+import type { Team } from 'resolve-team';
 /**
  * @group Channels
  * Schemas for managing Discord channel-related operations
@@ -191,10 +192,10 @@ export declare const channelAggregatedSchema: z.ZodObject<{
     } | undefined;
 }>;
 /**
- * Schema for match embed preparation data
- * @group Channel Embeds
+ * Schema for match embed display data
+ * @group Channel Creation
  */
-export declare const prepareMatchEmbedSchema: z.ZodObject<{
+export declare const matchEmbedDisplaySchema: z.ZodObject<{
     favored: z.ZodString;
     favoredTeamClr: 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"]>]>;
     home_team: z.ZodString;
@@ -756,15 +757,536 @@ export declare const incomingChannelDataSchema: z.ZodObject<{
         preferredTeams?: string[] | undefined;
     }[];
 }>;
+export declare const ChannelWithGuildAggregatedSchema: z.ZodObject<{
+    channel: z.ZodObject<{
+        metadata: z.ZodOptional<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;
+        }>>;
+        home_team: z.ZodString;
+        away_team: z.ZodString;
+        id: z.ZodString;
+        sport: z.ZodEnum<["nba", "nfl"]>;
+        created: z.ZodBoolean;
+        gametime: z.ZodDate;
+        channelname: z.ZodString;
+        matchOdds: z.ZodObject<{
+            favored: z.ZodString;
+            home_team_odds: z.ZodNumber;
+            away_team_odds: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            favored: string;
+            home_team_odds: number;
+            away_team_odds: number;
+        }, {
+            favored: string;
+            home_team_odds: number;
+            away_team_odds: number;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        home_team: string;
+        away_team: string;
+        sport: "nba" | "nfl";
+        id: string;
+        created: boolean;
+        gametime: Date;
+        channelname: string;
+        matchOdds: {
+            favored: string;
+            home_team_odds: number;
+            away_team_odds: number;
+        };
+        metadata?: {
+            headline?: string | null | undefined;
+            records?: {
+                home_team: {
+                    total_record: string;
+                };
+                away_team: {
+                    total_record: string;
+                };
+            } | null | undefined;
+        } | undefined;
+    }, {
+        home_team: string;
+        away_team: string;
+        sport: "nba" | "nfl";
+        id: string;
+        created: boolean;
+        gametime: Date;
+        channelname: string;
+        matchOdds: {
+            favored: string;
+            home_team_odds: number;
+            away_team_odds: number;
+        };
+        metadata?: {
+            headline?: string | null | undefined;
+            records?: {
+                home_team: {
+                    total_record: string;
+                };
+                away_team: {
+                    total_record: string;
+                };
+            } | null | undefined;
+        } | undefined;
+    }>;
+    guild: z.ZodObject<z.objectUtil.extendShape<{
+        guildId: z.ZodString;
+        bettingChannelId: z.ZodString;
+        gameCategoryId: z.ZodString;
+        preferredTeams: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        sport: z.ZodString;
+    }, {
+        eligibleMatches: z.ZodArray<z.ZodString, "many">;
+    }>, "strip", z.ZodTypeAny, {
+        guildId: string;
+        bettingChannelId: string;
+        gameCategoryId: string;
+        sport: string;
+        eligibleMatches: string[];
+        preferredTeams?: string[] | undefined;
+    }, {
+        guildId: string;
+        bettingChannelId: string;
+        gameCategoryId: string;
+        sport: string;
+        eligibleMatches: string[];
+        preferredTeams?: string[] | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    channel: {
+        home_team: string;
+        away_team: string;
+        sport: "nba" | "nfl";
+        id: string;
+        created: boolean;
+        gametime: Date;
+        channelname: string;
+        matchOdds: {
+            favored: string;
+            home_team_odds: number;
+            away_team_odds: number;
+        };
+        metadata?: {
+            headline?: string | null | undefined;
+            records?: {
+                home_team: {
+                    total_record: string;
+                };
+                away_team: {
+                    total_record: string;
+                };
+            } | null | undefined;
+        } | undefined;
+    };
+    guild: {
+        guildId: string;
+        bettingChannelId: string;
+        gameCategoryId: string;
+        sport: string;
+        eligibleMatches: string[];
+        preferredTeams?: string[] | undefined;
+    };
+}, {
+    channel: {
+        home_team: string;
+        away_team: string;
+        sport: "nba" | "nfl";
+        id: string;
+        created: boolean;
+        gametime: Date;
+        channelname: string;
+        matchOdds: {
+            favored: string;
+            home_team_odds: number;
+            away_team_odds: number;
+        };
+        metadata?: {
+            headline?: string | null | undefined;
+            records?: {
+                home_team: {
+                    total_record: string;
+                };
+                away_team: {
+                    total_record: string;
+                };
+            } | null | undefined;
+        } | undefined;
+    };
+    guild: {
+        guildId: string;
+        bettingChannelId: string;
+        gameCategoryId: string;
+        sport: string;
+        eligibleMatches: string[];
+        preferredTeams?: string[] | undefined;
+    };
+}>;
 /**
- * Type representing guild data with channel eligibility
- * @group Guilds
+ * Pluto aggregated data structure when creating a channel
+ * Pluto adds the favored team and match image
+ * @group Channel Creation
  */
+export declare const channelEmbedPayloadSchema: z.ZodObject<z.objectUtil.extendShape<{
+    channel: z.ZodObject<{
+        metadata: z.ZodOptional<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;
+        }>>;
+        home_team: z.ZodString;
+        away_team: z.ZodString;
+        id: z.ZodString;
+        sport: z.ZodEnum<["nba", "nfl"]>;
+        created: z.ZodBoolean;
+        gametime: z.ZodDate;
+        channelname: z.ZodString;
+        matchOdds: z.ZodObject<{
+            favored: z.ZodString;
+            home_team_odds: z.ZodNumber;
+            away_team_odds: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            favored: string;
+            home_team_odds: number;
+            away_team_odds: number;
+        }, {
+            favored: string;
+            home_team_odds: number;
+            away_team_odds: number;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        home_team: string;
+        away_team: string;
+        sport: "nba" | "nfl";
+        id: string;
+        created: boolean;
+        gametime: Date;
+        channelname: string;
+        matchOdds: {
+            favored: string;
+            home_team_odds: number;
+            away_team_odds: number;
+        };
+        metadata?: {
+            headline?: string | null | undefined;
+            records?: {
+                home_team: {
+                    total_record: string;
+                };
+                away_team: {
+                    total_record: string;
+                };
+            } | null | undefined;
+        } | undefined;
+    }, {
+        home_team: string;
+        away_team: string;
+        sport: "nba" | "nfl";
+        id: string;
+        created: boolean;
+        gametime: Date;
+        channelname: string;
+        matchOdds: {
+            favored: string;
+            home_team_odds: number;
+            away_team_odds: number;
+        };
+        metadata?: {
+            headline?: string | null | undefined;
+            records?: {
+                home_team: {
+                    total_record: string;
+                };
+                away_team: {
+                    total_record: string;
+                };
+            } | null | undefined;
+        } | undefined;
+    }>;
+    guild: z.ZodObject<z.objectUtil.extendShape<{
+        guildId: z.ZodString;
+        bettingChannelId: z.ZodString;
+        gameCategoryId: z.ZodString;
+        preferredTeams: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        sport: z.ZodString;
+    }, {
+        eligibleMatches: z.ZodArray<z.ZodString, "many">;
+    }>, "strip", z.ZodTypeAny, {
+        guildId: string;
+        bettingChannelId: string;
+        gameCategoryId: string;
+        sport: string;
+        eligibleMatches: string[];
+        preferredTeams?: string[] | undefined;
+    }, {
+        guildId: string;
+        bettingChannelId: string;
+        gameCategoryId: string;
+        sport: string;
+        eligibleMatches: string[];
+        preferredTeams?: string[] | undefined;
+    }>;
+}, {
+    metadata: 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;
+            };
+        }>>>;
+        favoredTeamInfo: z.ZodType<Team, z.ZodTypeDef, Team>;
+        matchImg: z.ZodNullable<z.ZodType<Buffer<ArrayBuffer>, z.ZodTypeDef, Buffer<ArrayBuffer>>>;
+    }, "strip", z.ZodTypeAny, {
+        favoredTeamInfo: Team;
+        matchImg: Buffer<ArrayBuffer> | null;
+        headline?: string | null | undefined;
+        records?: {
+            home_team: {
+                total_record: string;
+            };
+            away_team: {
+                total_record: string;
+            };
+        } | null | undefined;
+    }, {
+        favoredTeamInfo: Team;
+        matchImg: Buffer<ArrayBuffer> | null;
+        headline?: string | null | undefined;
+        records?: {
+            home_team: {
+                total_record: string;
+            };
+            away_team: {
+                total_record: string;
+            };
+        } | null | undefined;
+    }>;
+}>, "strip", z.ZodTypeAny, {
+    metadata: {
+        favoredTeamInfo: Team;
+        matchImg: Buffer<ArrayBuffer> | null;
+        headline?: string | null | undefined;
+        records?: {
+            home_team: {
+                total_record: string;
+            };
+            away_team: {
+                total_record: string;
+            };
+        } | null | undefined;
+    };
+    channel: {
+        home_team: string;
+        away_team: string;
+        sport: "nba" | "nfl";
+        id: string;
+        created: boolean;
+        gametime: Date;
+        channelname: string;
+        matchOdds: {
+            favored: string;
+            home_team_odds: number;
+            away_team_odds: number;
+        };
+        metadata?: {
+            headline?: string | null | undefined;
+            records?: {
+                home_team: {
+                    total_record: string;
+                };
+                away_team: {
+                    total_record: string;
+                };
+            } | null | undefined;
+        } | undefined;
+    };
+    guild: {
+        guildId: string;
+        bettingChannelId: string;
+        gameCategoryId: string;
+        sport: string;
+        eligibleMatches: string[];
+        preferredTeams?: string[] | undefined;
+    };
+}, {
+    metadata: {
+        favoredTeamInfo: Team;
+        matchImg: Buffer<ArrayBuffer> | null;
+        headline?: string | null | undefined;
+        records?: {
+            home_team: {
+                total_record: string;
+            };
+            away_team: {
+                total_record: string;
+            };
+        } | null | undefined;
+    };
+    channel: {
+        home_team: string;
+        away_team: string;
+        sport: "nba" | "nfl";
+        id: string;
+        created: boolean;
+        gametime: Date;
+        channelname: string;
+        matchOdds: {
+            favored: string;
+            home_team_odds: number;
+            away_team_odds: number;
+        };
+        metadata?: {
+            headline?: string | null | undefined;
+            records?: {
+                home_team: {
+                    total_record: string;
+                };
+                away_team: {
+                    total_record: string;
+                };
+            } | null | undefined;
+        } | undefined;
+    };
+    guild: {
+        guildId: string;
+        bettingChannelId: string;
+        gameCategoryId: string;
+        sport: string;
+        eligibleMatches: string[];
+        preferredTeams?: string[] | undefined;
+    };
+}>;
+export type ChannelWithGuildAggregated = z.infer<typeof ChannelWithGuildAggregatedSchema>;
+export type ChannelEmbedPayload = z.infer<typeof channelEmbedPayloadSchema>;
 export type ChannelEligibleGuild = z.infer<typeof channelEligibleGuildSchema>;
 export type ChannelDeletionJob = z.infer<typeof channelDeletionJobSchema>;
 export type ChannelDeletionResult = z.infer<typeof channelDeletionResultSchema>;
 export type ChannelDeletionEvent = z.infer<typeof channelDeletionEventSchema>;
 export type ChannelAggregated = z.infer<typeof channelAggregatedSchema>;
-export type PrepareMatchEmbed = z.infer<typeof prepareMatchEmbedSchema>;
+export type MatchEmbedDisplay = z.infer<typeof matchEmbedDisplaySchema>;
 export type ChannelCreationEvent = z.infer<typeof channelCreationEventSchema>;
 export type IncomingChannelData = z.infer<typeof incomingChannelDataSchema>;

package/dist/schemas/channels.js

@@ -1,6 +1,6 @@
 "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;
+exports.channelEmbedPayloadSchema = exports.ChannelWithGuildAggregatedSchema = exports.incomingChannelDataSchema = exports.channelCreationEventSchema = exports.channelEligibleGuildSchema = exports.matchEmbedDisplaySchema = exports.channelAggregatedSchema = exports.channelDeletionEventSchema = exports.channelDeletionResultSchema = exports.channelDeletionJobSchema = void 0;
 /**
  * @group Channels
  * Schemas for managing Discord channel-related operations
@@ -79,10 +79,10 @@ exports.channelAggregatedSchema = zod_1.z
 })
     .describe('Aggregated channel information including match and odds details');
 /**
- * Schema for match embed preparation data
- * @group Channel Embeds
+ * Schema for match embed display data
+ * @group Channel Creation
  */
-exports.prepareMatchEmbedSchema = zod_1.z
+exports.matchEmbedDisplaySchema = zod_1.z
     .object({
     favored: zod_1.z.string().describe('Team favored to win'),
     favoredTeamClr: colors_1.colorResolvableSchema.describe('Color for the favored team'),
@@ -102,7 +102,7 @@ exports.prepareMatchEmbedSchema = zod_1.z
         .optional()
         .describe('Optional team records'),
 })
-    .describe('Data structure for preparing match embed messages');
+    .describe('Data structure for match embed display formatting');
 /**
  * Schema for guild data with channel creation eligibility
  * @group Guilds
@@ -139,3 +139,21 @@ exports.incomingChannelDataSchema = zod_1.z
         .describe('Array of eligible guild data'),
 })
     .describe('Schema for Pluto to process channel creation events');
+exports.ChannelWithGuildAggregatedSchema = zod_1.z
+    .object({
+    channel: exports.channelAggregatedSchema,
+    guild: exports.channelEligibleGuildSchema,
+})
+    .describe('Combined data structure of a channel that will be created and the guild information paired with it');
+/**
+ * Pluto aggregated data structure when creating a channel
+ * Pluto adds the favored team and match image
+ * @group Channel Creation
+ */
+exports.channelEmbedPayloadSchema = exports.ChannelWithGuildAggregatedSchema.extend({
+    metadata: zod_1.z.object({
+        favoredTeamInfo: zod_1.z.custom().describe('Resolved team information'),
+        matchImg: zod_1.z.instanceof(Buffer).nullable().describe('Match image buffer'),
+        ...match_metadata_1.matchMetadataSchema.shape,
+    }),
+}).describe('Data required to create a channel and send an embed');

package/dist/schemas/colors.d.ts

@@ -1,3 +1,4 @@
+import type { ColorResolvable as DiscordColorResolvable } from 'discord.js';
 /**
  * @group Colors
  * Schemas for Discord color-related types and validations
@@ -10,6 +11,7 @@ import { z } from 'zod';
 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
+ * Directly compatible with Discord.js ColorResolvable type when discord.js is installed
  * @group Colors
  */
-export type ColorResolvable = z.infer<typeof colorResolvableSchema>;
+export type ColorResolvable = z.infer<typeof colorResolvableSchema> & DiscordColorResolvable;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@pluto-khronos/types",
-	"version": "0.1.0",
+	"version": "0.1.1",
 	"description": "Shared TypeScript types for Pluto & Khronos projects",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
@@ -13,7 +13,8 @@
 		"clean": "rm -rf dist",
 		"format": "biome check --write --unsafe .",
 		"docs": "typedoc",
-		"docs:watch": "typedoc --watch"
+		"docs:watch": "typedoc --watch",
+		"prepublish": "bun run build && bun run type-check && bun run format && bun run docs"
 	},
 	"publishConfig": {
 		"access": "public"
@@ -27,6 +28,7 @@
 		"@biomejs/biome": "1.9.4",
 		"@types/bun": "^1.2.3",
 		"@types/node": "^22.13.5",
+		"discord.js": "^14.18.0",
 		"lefthook": "^1.11.0",
 		"typedoc": "^0.27.8",
 		"typedoc-plugin-markdown": "^4.4.2",
@@ -36,6 +38,10 @@
 		"typescript": "^5.0.0"
 	},
 	"dependencies": {
+		"resolve-team": "^2.0.4",
 		"zod": "^3.24.2"
+	},
+	"peerDependencies": {
+		"discord.js": "^14.0.0"
 	}
 }