@pluto-khronos/types 0.1.1 → 0.2.0

package/dist/schemas/channels.js

@@ -19,9 +19,15 @@ const teams_1 = require("./teams");
  */
 exports.channelDeletionJobSchema = zod_1.z
     .object({
-    channelName: zod_1.z.string().describe('Name of the channel to be deleted'),
+    channelName: zod_1.z
+        .string({
+        error: (issue) => issue.input === undefined
+            ? { message: 'Channel name is required.' }
+            : { message: 'Channel name must be a string.' },
+    })
+        .describe('Name of the channel to be deleted'),
     jobId: zod_1.z
-        .string()
+        .string({ error: 'Job ID must be a string if provided.' })
         .optional()
         .describe('Optional unique identifier for the deletion job'),
 })
@@ -33,10 +39,23 @@ exports.channelDeletionJobSchema = zod_1.z
 exports.channelDeletionResultSchema = zod_1.z
     .object({
     success: zod_1.z
-        .boolean()
+        .boolean({
+        error: (issue) => issue.input === undefined
+            ? { message: 'Success status is required.' }
+            : { message: 'Success status must be a 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'),
+    channelName: zod_1.z
+        .string({
+        error: (issue) => issue.input === undefined
+            ? { message: 'Channel name is required.' }
+            : { message: 'Channel name must be a string.' },
+    })
+        .describe('Name of the channel that was processed'),
+    error: zod_1.z
+        .string({ error: 'Error message must be a string if present.' })
+        .optional()
+        .describe('Error message if deletion failed'),
 })
     .describe('BullMQ Schema structure for channel deletion results');
 /**
@@ -46,15 +65,27 @@ exports.channelDeletionResultSchema = zod_1.z
 exports.channelDeletionEventSchema = zod_1.z
     .object({
     channelIds: zod_1.z
-        .array(zod_1.z.string())
+        .array(zod_1.z.string({ error: 'Each channel ID in the array must be a string.' }), {
+        error: (issue) => issue.input === undefined
+            ? { message: 'An array of channel IDs is required.' }
+            : { message: 'Channel IDs must be provided as an array.' },
+    })
         .describe('Array of channel IDs to be deleted from Discord'),
     metadata: zod_1.z
         .object({
         publishedAt: zod_1.z
-            .date()
+            .date({
+            error: (issue) => issue.input === undefined
+                ? { message: 'Published timestamp is required.' }
+                : { message: 'Published at must be a valid date.' },
+        })
             .describe('Timestamp when the deletion event was published'),
         eventId: zod_1.z
-            .string()
+            .string({
+            error: (issue) => issue.input === undefined
+                ? { message: 'Event ID is required.' }
+                : { message: 'Event ID must be a string.' },
+        })
             .describe('Unique identifier for tracking the deletion event'),
     })
         .describe('Metadata associated with the channel deletion event'),
@@ -66,13 +97,35 @@ exports.channelDeletionEventSchema = zod_1.z
  */
 exports.channelAggregatedSchema = zod_1.z
     .object({
-    id: zod_1.z.string().describe('Unique identifier for the channel'),
+    id: zod_1.z
+        .string({
+        error: (issue) => issue.input === undefined
+            ? { message: 'Channel ID is required.' }
+            : { message: 'Channel ID must be a 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'),
+        .boolean({
+        error: (issue) => issue.input === undefined
+            ? { message: 'Creation status is required.' }
+            : { message: 'Creation status must be a boolean.' },
+    })
+        .describe('Whether the channel has been created in Discord [DEPRECATED FLAG]'),
+    gametime: zod_1.z
+        .date({
+        error: (issue) => issue.input === undefined
+            ? { message: 'Game time is required.' }
+            : { message: 'Game time must be a valid date.' },
+    })
+        .describe('Scheduled time for the game/match'),
+    channelname: zod_1.z
+        .string({
+        error: (issue) => issue.input === undefined
+            ? { message: 'Channel name is required.' }
+            : { message: 'Channel name must be a string.' },
+    })
+        .describe('Name of the Discord channel'),
     matchOdds: betting_1.matchOddsSchema,
     ...teams_1.matchTeamsSchema.shape,
     metadata: match_metadata_1.matchMetadataSchema.optional(),
@@ -84,18 +137,56 @@ exports.channelAggregatedSchema = zod_1.z
  */
 exports.matchEmbedDisplaySchema = zod_1.z
     .object({
-    favored: zod_1.z.string().describe('Team favored to win'),
+    favored: zod_1.z
+        .string({
+        error: (issue) => issue.input === undefined
+            ? { message: 'Favored team name is required.' }
+            : { message: 'Favored team name must be a 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'),
+    home_team: zod_1.z
+        .string({
+        error: (issue) => issue.input === undefined
+            ? { message: 'Home team name is required.' }
+            : { message: 'Home team name must be a string.' },
+    })
+        .describe('Full name of home team'),
     homeTeamShortName: zod_1.z
-        .string()
+        .string({
+        error: (issue) => issue.input === undefined
+            ? { message: 'Home team short name is required.' }
+            : { message: 'Home team short name must be a string.' },
+    })
         .describe('Short name/abbreviation of home team'),
-    away_team: zod_1.z.string().describe('Full name of away team'),
+    away_team: zod_1.z
+        .string({
+        error: (issue) => issue.input === undefined
+            ? { message: 'Away team name is required.' }
+            : { message: 'Away team name must be a string.' },
+    })
+        .describe('Full name of away team'),
     awayTeamShortName: zod_1.z
-        .string()
+        .string({
+        error: (issue) => issue.input === undefined
+            ? { message: 'Away team short name is required.' }
+            : { message: 'Away team short name must be a 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'),
+    bettingChanId: zod_1.z
+        .string({
+        error: (issue) => issue.input === undefined
+            ? { message: 'Betting channel ID is required.' }
+            : { message: 'Betting channel ID must be a string.' },
+    })
+        .describe('ID of the betting channel'),
+    header: zod_1.z
+        .string({
+        error: (issue) => issue.input === undefined
+            ? { message: 'Embed header is required.' }
+            : { message: 'Embed header must be a string.' },
+    })
+        .describe('Header text for the match embed'),
     sport: sports_1.sportsServingSchema.describe('Sport type for the match'),
     records: sports_1.teamRecordsResultSchema
         .nullable()
@@ -110,7 +201,11 @@ exports.matchEmbedDisplaySchema = zod_1.z
 exports.channelEligibleGuildSchema = guilds_1.guildConfigSchema
     .extend({
     eligibleMatches: zod_1.z
-        .array(zod_1.z.string())
+        .array(zod_1.z.string({ error: 'Each match ID must be a string.' }), {
+        error: (issue) => issue.input === undefined
+            ? { message: 'Eligible matches array is required.' }
+            : { message: 'Eligible matches must be an array.' },
+    })
         .describe('List of match IDs eligible for channel creation'),
 })
     .describe('Guild data for channel creation eligibility');
@@ -122,7 +217,7 @@ exports.channelCreationEventSchema = zod_1.z
     .object({
     channel: exports.channelAggregatedSchema,
     guild: exports.channelEligibleGuildSchema,
-    metadata: shared_1.bullMqMetadataSchema,
+    metadata: shared_1.bullMqMetadataSchema.optional(),
 })
     .describe('Event data for channel creation operations');
 /**
@@ -132,10 +227,18 @@ exports.channelCreationEventSchema = zod_1.z
 exports.incomingChannelDataSchema = zod_1.z
     .object({
     channels: zod_1.z
-        .array(exports.channelAggregatedSchema)
+        .array(exports.channelAggregatedSchema, {
+        error: (issue) => issue.input === undefined
+            ? { message: 'Channels array is required.' }
+            : { message: 'Channels must be an array.' },
+    })
         .describe('Array of channel data'),
     guilds: zod_1.z
-        .array(exports.channelEligibleGuildSchema)
+        .array(exports.channelEligibleGuildSchema, {
+        error: (issue) => issue.input === undefined
+            ? { message: 'Guilds array is required.' }
+            : { message: 'Guilds must be an array.' },
+    })
         .describe('Array of eligible guild data'),
 })
     .describe('Schema for Pluto to process channel creation events');
@@ -153,7 +256,10 @@ exports.ChannelWithGuildAggregatedSchema = zod_1.z
 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'),
+        matchImg: zod_1.z
+            .instanceof(Buffer, { message: 'Match image must be a Buffer.' })
+            .nullable()
+            .describe('Match image buffer'),
         ...match_metadata_1.matchMetadataSchema.shape,
-    }),
+    }, { error: 'Invalid Channel Embed Payload metadata received' }),
 }).describe('Data required to create a channel and send an embed');

package/dist/schemas/colors.d.ts

@@ -1,4 +1,3 @@
-import type { ColorResolvable as DiscordColorResolvable } from 'discord.js';
 /**
  * @group Colors
  * Schemas for Discord color-related types and validations
@@ -8,10 +7,42 @@ 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"]>]>;
+export declare const colorResolvableSchema: z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodEnum<{
+    DEFAULT: "DEFAULT";
+    WHITE: "WHITE";
+    AQUA: "AQUA";
+    GREEN: "GREEN";
+    BLUE: "BLUE";
+    YELLOW: "YELLOW";
+    PURPLE: "PURPLE";
+    LUMINOUS_VIVID_PINK: "LUMINOUS_VIVID_PINK";
+    FUCHSIA: "FUCHSIA";
+    GOLD: "GOLD";
+    ORANGE: "ORANGE";
+    RED: "RED";
+    GREY: "GREY";
+    NAVY: "NAVY";
+    DARK_AQUA: "DARK_AQUA";
+    DARK_GREEN: "DARK_GREEN";
+    DARK_BLUE: "DARK_BLUE";
+    DARK_PURPLE: "DARK_PURPLE";
+    DARK_VIVID_PINK: "DARK_VIVID_PINK";
+    DARK_GOLD: "DARK_GOLD";
+    DARK_ORANGE: "DARK_ORANGE";
+    DARK_RED: "DARK_RED";
+    DARK_GREY: "DARK_GREY";
+    DARKER_GREY: "DARKER_GREY";
+    LIGHT_GREY: "LIGHT_GREY";
+    DARK_NAVY: "DARK_NAVY";
+    BLURPLE: "BLURPLE";
+    GREYPLE: "GREYPLE";
+    DARK_BUT_NOT_BLACK: "DARK_BUT_NOT_BLACK";
+    NOT_QUITE_BLACK: "NOT_QUITE_BLACK";
+    RANDOM: "RANDOM";
+}>]>, z.ZodTransform<number | "Default" | "White" | "Aqua" | "Green" | "Blue" | "Yellow" | "Purple" | "LuminousVividPink" | "Fuchsia" | "Gold" | "Orange" | "Red" | "Grey" | "Navy" | "DarkAqua" | "DarkGreen" | "DarkBlue" | "DarkPurple" | "DarkVividPink" | "DarkGold" | "DarkOrange" | "DarkRed" | "DarkGrey" | "DarkerGrey" | "LightGrey" | "DarkNavy" | "Blurple" | "Greyple" | "DarkButNotBlack" | "NotQuiteBlack" | "Random" | readonly [red: number, green: number, blue: number] | `#${string}`, string | number>>;
 /**
  * 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> & DiscordColorResolvable;
+export type ColorResolvable = z.output<typeof colorResolvableSchema>;

package/dist/schemas/colors.js

@@ -58,4 +58,5 @@ exports.colorResolvableSchema = zod_1.z
     ])
         .describe('Discord.js predefined color names'),
 ])
+    .transform((val) => val)
     .describe('Discord.js ColorResolvable - supports hex codes, integers, and predefined color names');

package/dist/schemas/guilds.d.ts

@@ -11,21 +11,9 @@ export declare const guildConfigSchema: z.ZodObject<{
     guildId: z.ZodString;
     bettingChannelId: z.ZodString;
     gameCategoryId: z.ZodString;
-    preferredTeams: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    preferredTeams: z.ZodOptional<z.ZodArray<z.ZodString>>;
     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;
-}>;
+}, z.core.$strip>;
 /**
  * Type representing base guild configuration
  * @group Guilds

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

@@ -12,52 +12,10 @@ export declare const matchMetadataSchema: z.ZodObject<{
     records: z.ZodNullable<z.ZodOptional<z.ZodObject<{
         home_team: z.ZodObject<{
             total_record: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
-            total_record: string;
-        }, {
-            total_record: string;
-        }>;
+        }, z.core.$strip>;
         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;
-}>;
+        }, z.core.$strip>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
 export type MatchMetadata = z.infer<typeof matchMetadataSchema>;

package/dist/schemas/shared.d.ts

@@ -10,13 +10,7 @@ import { z } from 'zod';
 export declare const bullMqMetadataSchema: z.ZodObject<{
     publishedAt: z.ZodDate;
     eventId: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    publishedAt: Date;
-    eventId: string;
-}, {
-    publishedAt: Date;
-    eventId: string;
-}>;
+}, z.core.$strip>;
 /**
  * Type representing BullMQ job metadata
  * @group Queue

package/dist/schemas/sports.d.ts

@@ -15,18 +15,17 @@ export declare const SportsServing: {
  * Schema for supported sports in the application
  * @group Sports
  */
-export declare const sportsServingSchema: z.ZodEnum<["nba", "nfl"]>;
+export declare const sportsServingSchema: z.ZodEnum<{
+    nba: "nba";
+    nfl: "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;
-}>;
+}, z.core.$strip>;
 /**
  * Schema for both teams' record information in a match
  * @group Sports
@@ -34,33 +33,11 @@ export declare const teamRecordSchema: z.ZodObject<{
 export declare const teamRecordsResultSchema: z.ZodObject<{
     home_team: z.ZodObject<{
         total_record: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        total_record: string;
-    }, {
-        total_record: string;
-    }>;
+    }, z.core.$strip>;
     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;
-    };
-}>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
 /**
  * Type representing a team's record
  * @group Sports

package/dist/schemas/teams.d.ts

@@ -10,13 +10,7 @@ import { z } from 'zod';
 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;
-}>;
+}, z.core.$strip>;
 /**
  * Schema for team abbreviations
  * @group Teams
@@ -24,12 +18,6 @@ export declare const matchTeamsSchema: z.ZodObject<{
 export declare const teamAbbreviationsSchema: z.ZodObject<{
     homeTeamShortName: z.ZodString;
     awayTeamShortName: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    homeTeamShortName: string;
-    awayTeamShortName: string;
-}, {
-    homeTeamShortName: string;
-    awayTeamShortName: string;
-}>;
+}, z.core.$strip>;
 export type MatchTeams = z.infer<typeof matchTeamsSchema>;
 export type TeamAbbreviations = z.infer<typeof teamAbbreviationsSchema>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@pluto-khronos/types",
-	"version": "0.1.1",
+	"version": "0.2.0",
 	"description": "Shared TypeScript types for Pluto & Khronos projects",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
@@ -26,20 +26,20 @@
 	"license": "MIT",
 	"devDependencies": {
 		"@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",
-		"typedoc-plugin-mdn-links": "^4.0.14",
-		"typedoc-plugin-zod": "^1.3.1",
-		"typedoc-theme-hierarchy": "^5.0.4",
-		"typescript": "^5.0.0"
+		"@types/bun": "^1.2.22",
+		"@types/node": "^22.18.5",
+		"discord.js": "^14.22.1",
+		"lefthook": "^1.13.1",
+		"typedoc": "^0.27.9",
+		"typedoc-plugin-markdown": "^4.8.1",
+		"typedoc-plugin-mdn-links": "^4.0.15",
+		"typedoc-plugin-zod": "^1.4.2",
+		"typedoc-theme-hierarchy": "^5.0.5",
+		"typescript": "^5.9.2"
 	},
 	"dependencies": {
 		"resolve-team": "^2.0.4",
-		"zod": "^3.24.2"
+		"zod": "^4.1.11"
 	},
 	"peerDependencies": {
 		"discord.js": "^14.0.0"

package/dist/types.d.ts

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

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