bupkis 0.18.3 → 1.0.0

package/dist/assertion/impl/sync-date.d.ts

@@ -0,0 +1,209 @@
+/**
+ * Date and time-related assertions for temporal testing scenarios.
+ *
+ * This module provides comprehensive Date and Time assertions with natural
+ * language syntax for testing applications that deal with temporal data,
+ * scheduling, timestamps, and time-based operations.
+ *
+ * @packageDocumentation
+ * @groupDescription Date/Time Assertions
+ * Temporal assertions for dates, times, durations, and time-based comparisons.
+ *
+ * @showGroups
+ */
+/**
+ * Asserts that the subject is a valid date (Date object, ISO string, or
+ * timestamp).
+ *
+ * @example
+ *
+ * ```ts
+ * expect(new Date(), 'to be a valid date'); // passes
+ * expect('2023-01-01T00:00:00Z', 'to be a valid date'); // passes
+ * expect(1640995200000, 'to be a valid date'); // passes
+ * expect('invalid', 'to be a valid date'); // fails
+ * ```
+ *
+ * @group Date/Time Assertions
+ * @bupkisAnchor unknown-to-be-a-valid-date
+ * @bupkisAssertionCategory date
+ */
+export declare const validDateAssertion: import("../assertion-types.js").AssertionStandardSchemaSync<readonly [readonly ["to be a valid date", "to be date-like"]], import("zod").ZodUnion<readonly [import("zod").ZodDate, import("zod").ZodUnion<readonly [import("zod").ZodISODateTime, import("zod").ZodISODate]>, import("zod").ZodInt]>, never>;
+/**
+ * Asserts that the subject is before another date.
+ *
+ * @example
+ *
+ * ```ts
+ * expect(new Date('2022-01-01'), 'to be before', new Date('2023-01-01')); // passes
+ * expect(new Date('2023-01-01'), 'to be before', new Date('2022-01-01')); // fails
+ * expect('2022-01-01', 'to be before', '2023-01-01'); // passes
+ * ```
+ *
+ * @group Date/Time Assertions
+ * @bupkisAnchor date-like-to-be-before-date-like
+ * @bupkisAssertionCategory date
+ */
+export declare const beforeAssertion: import("../assertion-types.js").AssertionFunctionSync<readonly [import("zod").ZodUnion<readonly [import("zod").ZodDate, import("zod").ZodUnion<readonly [import("zod").ZodISODateTime, import("zod").ZodISODate]>, import("zod").ZodInt]>, "to be before", import("zod").ZodUnion<readonly [import("zod").ZodDate, import("zod").ZodUnion<readonly [import("zod").ZodISODateTime, import("zod").ZodISODate]>, import("zod").ZodInt]>], (subject: string | number | Date, other: string | number | Date) => {
+    message: string;
+    schema?: undefined;
+    subject?: undefined;
+} | {
+    schema: import("zod").ZodDate;
+    subject: Date;
+    message?: undefined;
+}, readonly [import("zod").ZodUnion<readonly [import("zod").ZodDate, import("zod").ZodUnion<readonly [import("zod").ZodISODateTime, import("zod").ZodISODate]>, import("zod").ZodInt]>, import("../assertion-types.js").PhraseLiteralSlot<"to be before">, import("zod").ZodUnion<readonly [import("zod").ZodDate, import("zod").ZodUnion<readonly [import("zod").ZodISODateTime, import("zod").ZodISODate]>, import("zod").ZodInt]>]>;
+/**
+ * Asserts that the subject is after another date.
+ *
+ * @example
+ *
+ * ```ts
+ * expect(new Date('2023-01-01'), 'to be after', new Date('2022-01-01')); // passes
+ * expect(new Date('2022-01-01'), 'to be after', new Date('2023-01-01')); // fails
+ * expect('2023-01-01', 'to be after', '2022-01-01'); // passes
+ * ```
+ *
+ * @group Date/Time Assertions
+ * @bupkisAnchor date-like-to-be-after-date-like
+ * @bupkisAssertionCategory date
+ */
+export declare const afterAssertion: import("../assertion-types.js").AssertionFunctionSync<readonly [import("zod").ZodUnion<readonly [import("zod").ZodDate, import("zod").ZodUnion<readonly [import("zod").ZodISODateTime, import("zod").ZodISODate]>, import("zod").ZodInt]>, "to be after", import("zod").ZodUnion<readonly [import("zod").ZodDate, import("zod").ZodUnion<readonly [import("zod").ZodISODateTime, import("zod").ZodISODate]>, import("zod").ZodInt]>], (subject: string | number | Date, other: string | number | Date) => {
+    message: string;
+    schema?: undefined;
+    subject?: undefined;
+} | {
+    schema: import("zod").ZodDate;
+    subject: Date;
+    message?: undefined;
+}, readonly [import("zod").ZodUnion<readonly [import("zod").ZodDate, import("zod").ZodUnion<readonly [import("zod").ZodISODateTime, import("zod").ZodISODate]>, import("zod").ZodInt]>, import("../assertion-types.js").PhraseLiteralSlot<"to be after">, import("zod").ZodUnion<readonly [import("zod").ZodDate, import("zod").ZodUnion<readonly [import("zod").ZodISODateTime, import("zod").ZodISODate]>, import("zod").ZodInt]>]>;
+/**
+ * Asserts that the subject is between two dates (inclusive).
+ *
+ * @example
+ *
+ * ```ts
+ * expect(
+ *   new Date('2022-06-01'),
+ *   'to be between',
+ *   new Date('2022-01-01'),
+ *   new Date('2022-12-31'),
+ * ); // passes
+ * expect(
+ *   new Date('2023-01-01'),
+ *   'to be between',
+ *   new Date('2022-01-01'),
+ *   new Date('2022-12-31'),
+ * ); // fails
+ * ```
+ *
+ * @group Date/Time Assertions
+ * @bupkisAnchor date-like-to-be-between-date-like-and-date-like
+ * @bupkisAssertionCategory date
+ */
+export declare const betweenAssertion: import("../assertion-types.js").AssertionFunctionSync<readonly [import("zod").ZodUnion<readonly [import("zod").ZodDate, import("zod").ZodUnion<readonly [import("zod").ZodISODateTime, import("zod").ZodISODate]>, import("zod").ZodInt]>, "to be between", import("zod").ZodUnion<readonly [import("zod").ZodDate, import("zod").ZodUnion<readonly [import("zod").ZodISODateTime, import("zod").ZodISODate]>, import("zod").ZodInt]>, "and", import("zod").ZodUnion<readonly [import("zod").ZodDate, import("zod").ZodUnion<readonly [import("zod").ZodISODateTime, import("zod").ZodISODate]>, import("zod").ZodInt]>], (subject: string | number | Date, start: string | number | Date, end: string | number | Date) => {
+    message: string;
+    schema?: undefined;
+    subject?: undefined;
+} | {
+    schema: import("zod").ZodDate;
+    subject: Date;
+    message?: undefined;
+}, readonly [import("zod").ZodUnion<readonly [import("zod").ZodDate, import("zod").ZodUnion<readonly [import("zod").ZodISODateTime, import("zod").ZodISODate]>, import("zod").ZodInt]>, import("../assertion-types.js").PhraseLiteralSlot<"to be between">, import("zod").ZodUnion<readonly [import("zod").ZodDate, import("zod").ZodUnion<readonly [import("zod").ZodISODateTime, import("zod").ZodISODate]>, import("zod").ZodInt]>, import("../assertion-types.js").PhraseLiteralSlot<"and">, import("zod").ZodUnion<readonly [import("zod").ZodDate, import("zod").ZodUnion<readonly [import("zod").ZodISODateTime, import("zod").ZodISODate]>, import("zod").ZodInt]>]>;
+/**
+ * Asserts that the subject is the same date as another (ignoring time).
+ *
+ * @example
+ *
+ * ```ts
+ * expect(
+ *   new Date('2023-01-01T10:00:00'),
+ *   'to be the same date as',
+ *   new Date('2023-01-01T15:30:00'),
+ * ); // passes
+ * expect(
+ *   new Date('2023-01-01'),
+ *   'to be the same date as',
+ *   new Date('2023-01-02'),
+ * ); // fails
+ * ```
+ *
+ * @group Date/Time Assertions
+ * @bupkisAnchor date-like-to-be-the-same-date-as-date-like
+ * @bupkisAssertionCategory date
+ */
+export declare const sameDateAssertion: import("../assertion-types.js").AssertionFunctionSync<readonly [import("zod").ZodUnion<readonly [import("zod").ZodDate, import("zod").ZodUnion<readonly [import("zod").ZodISODateTime, import("zod").ZodISODate]>, import("zod").ZodInt]>, "to be the same date as", import("zod").ZodUnion<readonly [import("zod").ZodDate, import("zod").ZodUnion<readonly [import("zod").ZodISODateTime, import("zod").ZodISODate]>, import("zod").ZodInt]>], (subject: string | number | Date, other: string | number | Date) => {
+    message: string;
+    actual?: undefined;
+    expected?: undefined;
+} | {
+    actual: string;
+    expected: string;
+    message: string;
+} | undefined, readonly [import("zod").ZodUnion<readonly [import("zod").ZodDate, import("zod").ZodUnion<readonly [import("zod").ZodISODateTime, import("zod").ZodISODate]>, import("zod").ZodInt]>, import("../assertion-types.js").PhraseLiteralSlot<"to be the same date as">, import("zod").ZodUnion<readonly [import("zod").ZodDate, import("zod").ZodUnion<readonly [import("zod").ZodISODateTime, import("zod").ZodISODate]>, import("zod").ZodInt]>]>;
+/**
+ * Asserts that the subject is equal to another date within a tolerance.
+ *
+ * @example
+ *
+ * ```ts
+ * const date1 = new Date('2023-01-01T10:00:00.000Z');
+ * const date2 = new Date('2023-01-01T10:00:00.500Z');
+ * expect(date1, 'to equal', date2, 'within', '1 second'); // passes
+ * expect(date1, 'to equal', date2, 'within', '100 milliseconds'); // fails
+ * ```
+ *
+ * @group Date/Time Assertions
+ * @bupkisAnchor date-like-to-equal-date-like-within-duration
+ * @bupkisAssertionCategory date
+ */
+export declare const equalWithinAssertion: import("../assertion-types.js").AssertionFunctionSync<readonly [import("zod").ZodUnion<readonly [import("zod").ZodDate, import("zod").ZodUnion<readonly [import("zod").ZodISODateTime, import("zod").ZodISODate]>, import("zod").ZodInt]>, "to equal", import("zod").ZodUnion<readonly [import("zod").ZodDate, import("zod").ZodUnion<readonly [import("zod").ZodISODateTime, import("zod").ZodISODate]>, import("zod").ZodInt]>, "within", import("zod").ZodCustomStringFormat<"duration">], (subject: string | number | Date, other: string | number | Date, toleranceStr: string) => {
+    message: string;
+    actual?: undefined;
+    expected?: undefined;
+} | {
+    actual: {
+        difference: number;
+    };
+    expected: {
+        maxDifference: number;
+    };
+    message: string;
+} | undefined, readonly [import("zod").ZodUnion<readonly [import("zod").ZodDate, import("zod").ZodUnion<readonly [import("zod").ZodISODateTime, import("zod").ZodISODate]>, import("zod").ZodInt]>, import("../assertion-types.js").PhraseLiteralSlot<"to equal">, import("zod").ZodUnion<readonly [import("zod").ZodDate, import("zod").ZodUnion<readonly [import("zod").ZodISODateTime, import("zod").ZodISODate]>, import("zod").ZodInt]>, import("../assertion-types.js").PhraseLiteralSlot<"within">, import("zod").ZodCustomStringFormat<"duration">]>;
+/**
+ * Asserts that the subject is a weekend (Saturday or Sunday) in UTC.
+ *
+ * @example
+ *
+ * ```ts
+ * expect(new Date('2023-01-07'), 'to be a weekend'); // passes (Saturday in UTC)
+ * expect(new Date('2023-01-08'), 'to be a weekend'); // passes (Sunday in UTC)
+ * expect(new Date('2023-01-09'), 'to be a weekend'); // fails (Monday in UTC)
+ * ```
+ *
+ * @group Date/Time Assertions
+ * @bupkisAnchor unknown-to-be-a-weekend
+ * @bupkisAssertionCategory date
+ */
+export declare const weekendAssertion: import("../assertion-types.js").AssertionFunctionSync<readonly ["to be a weekend"], (subject: unknown) => {
+    message: string;
+} | undefined, never>;
+/**
+ * Asserts that the subject is a weekday (Monday through Friday) in UTC.
+ *
+ * @example
+ *
+ * ```ts
+ * expect(new Date('2023-01-09'), 'to be a weekday'); // passes (Monday in UTC)
+ * expect(new Date('2023-01-13'), 'to be a weekday'); // passes (Friday in UTC)
+ * expect(new Date('2023-01-07'), 'to be a weekday'); // fails (Saturday in UTC)
+ * ```
+ *
+ * @group Date/Time Assertions
+ * @bupkisAnchor unknown-to-be-a-weekday
+ * @bupkisAssertionCategory date
+ */
+export declare const weekdayAssertion: import("../assertion-types.js").AssertionFunctionSync<readonly ["to be a weekday"], (subject: unknown) => {
+    message: string;
+} | undefined, never>;
+//# sourceMappingURL=sync-date.d.ts.map

package/dist/assertion/impl/sync-date.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sync-date.d.ts","sourceRoot":"","sources":["../../../src/assertion/impl/sync-date.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAmCH;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,kBAAkB,8SAG9B,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,eAAe;;;;;;;;saAsB3B,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,cAAc;;;;;;;;qaAsB1B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;4oBAkC5B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;4bA6B7B,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;4hBAwChC,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB;;qBAmB5B,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB;;qBAmB5B,CAAC"}

package/dist/assertion/impl/sync-date.js

@@ -0,0 +1,338 @@
+/**
+ * Date and time-related assertions for temporal testing scenarios.
+ *
+ * This module provides comprehensive Date and Time assertions with natural
+ * language syntax for testing applications that deal with temporal data,
+ * scheduling, timestamps, and time-based operations.
+ *
+ * @packageDocumentation
+ * @groupDescription Date/Time Assertions
+ * Temporal assertions for dates, times, durations, and time-based comparisons.
+ *
+ * @showGroups
+ */
+import { DAY_NAMES } from "../../constant.js";
+import { DateLikeFormatSchema, DateSchema, DurationFormatSchema, DurationSchema, } from "../../schema.js";
+import { createAssertion } from "../create.js";
+const { isNaN } = Number;
+const { abs } = Math;
+/**
+ * Converts various date-like inputs to Date objects for comparison. Supports
+ * Date objects, ISO strings, and timestamps.
+ *
+ * @function
+ */
+const toDate = (value) => {
+    if (value instanceof Date) {
+        return value;
+    }
+    if (typeof value === 'string') {
+        const parsed = new Date(value);
+        return isNaN(parsed.getTime()) ? null : parsed;
+    }
+    if (typeof value === 'number') {
+        const parsed = new Date(value);
+        return isNaN(parsed.getTime()) ? null : parsed;
+    }
+    return null;
+};
+/**
+ * Asserts that the subject is a valid date (Date object, ISO string, or
+ * timestamp).
+ *
+ * @example
+ *
+ * ```ts
+ * expect(new Date(), 'to be a valid date'); // passes
+ * expect('2023-01-01T00:00:00Z', 'to be a valid date'); // passes
+ * expect(1640995200000, 'to be a valid date'); // passes
+ * expect('invalid', 'to be a valid date'); // fails
+ * ```
+ *
+ * @group Date/Time Assertions
+ * @bupkisAnchor unknown-to-be-a-valid-date
+ * @bupkisAssertionCategory date
+ */
+export const validDateAssertion = createAssertion([['to be a valid date', 'to be date-like']], DateLikeFormatSchema);
+/**
+ * Asserts that the subject is before another date.
+ *
+ * @example
+ *
+ * ```ts
+ * expect(new Date('2022-01-01'), 'to be before', new Date('2023-01-01')); // passes
+ * expect(new Date('2023-01-01'), 'to be before', new Date('2022-01-01')); // fails
+ * expect('2022-01-01', 'to be before', '2023-01-01'); // passes
+ * ```
+ *
+ * @group Date/Time Assertions
+ * @bupkisAnchor date-like-to-be-before-date-like
+ * @bupkisAssertionCategory date
+ */
+export const beforeAssertion = createAssertion([DateLikeFormatSchema, 'to be before', DateLikeFormatSchema], (subject, other) => {
+    const subjectDate = toDate(subject);
+    const otherDate = toDate(other);
+    if (!subjectDate) {
+        return {
+            message: `Expected subject to be a valid date, but received: ${subject}`,
+        };
+    }
+    if (!otherDate) {
+        return {
+            message: `Expected comparison date to be a valid date, but received: ${other}`,
+        };
+    }
+    // Use Zod's date validation with max constraint for better error messages
+    return {
+        schema: DateSchema.max(new Date(otherDate.getTime() - 1)),
+        subject: subjectDate,
+    };
+});
+/**
+ * Asserts that the subject is after another date.
+ *
+ * @example
+ *
+ * ```ts
+ * expect(new Date('2023-01-01'), 'to be after', new Date('2022-01-01')); // passes
+ * expect(new Date('2022-01-01'), 'to be after', new Date('2023-01-01')); // fails
+ * expect('2023-01-01', 'to be after', '2022-01-01'); // passes
+ * ```
+ *
+ * @group Date/Time Assertions
+ * @bupkisAnchor date-like-to-be-after-date-like
+ * @bupkisAssertionCategory date
+ */
+export const afterAssertion = createAssertion([DateLikeFormatSchema, 'to be after', DateLikeFormatSchema], (subject, other) => {
+    const subjectDate = toDate(subject);
+    const otherDate = toDate(other);
+    if (subjectDate === null) {
+        return {
+            message: `Expected subject to be a valid date, but received: ${subject}`,
+        };
+    }
+    if (otherDate === null) {
+        return {
+            message: `Expected comparison date to be a valid date, but received: ${other}`,
+        };
+    }
+    // Use Zod's date validation with min constraint for better error messages
+    return {
+        schema: DateSchema.min(new Date(otherDate.getTime() + 1)),
+        subject: subjectDate,
+    };
+});
+/**
+ * Asserts that the subject is between two dates (inclusive).
+ *
+ * @example
+ *
+ * ```ts
+ * expect(
+ *   new Date('2022-06-01'),
+ *   'to be between',
+ *   new Date('2022-01-01'),
+ *   new Date('2022-12-31'),
+ * ); // passes
+ * expect(
+ *   new Date('2023-01-01'),
+ *   'to be between',
+ *   new Date('2022-01-01'),
+ *   new Date('2022-12-31'),
+ * ); // fails
+ * ```
+ *
+ * @group Date/Time Assertions
+ * @bupkisAnchor date-like-to-be-between-date-like-and-date-like
+ * @bupkisAssertionCategory date
+ */
+export const betweenAssertion = createAssertion([
+    DateLikeFormatSchema,
+    'to be between',
+    DateLikeFormatSchema,
+    'and',
+    DateLikeFormatSchema,
+], (subject, start, end) => {
+    const subjectDate = toDate(subject);
+    const startDate = toDate(start);
+    const endDate = toDate(end);
+    if (!subjectDate) {
+        return {
+            message: `Expected subject to be a valid date, but received: ${subject}`,
+        };
+    }
+    if (!startDate) {
+        return {
+            message: `Expected start date to be a valid date, but received: ${start}`,
+        };
+    }
+    if (!endDate) {
+        return {
+            message: `Expected end date to be a valid date, but received: ${end}`,
+        };
+    }
+    // Use Zod's date validation with min/max constraints for better error messages
+    return {
+        schema: DateSchema.min(startDate).max(endDate),
+        subject: subjectDate,
+    };
+});
+/**
+ * Asserts that the subject is the same date as another (ignoring time).
+ *
+ * @example
+ *
+ * ```ts
+ * expect(
+ *   new Date('2023-01-01T10:00:00'),
+ *   'to be the same date as',
+ *   new Date('2023-01-01T15:30:00'),
+ * ); // passes
+ * expect(
+ *   new Date('2023-01-01'),
+ *   'to be the same date as',
+ *   new Date('2023-01-02'),
+ * ); // fails
+ * ```
+ *
+ * @group Date/Time Assertions
+ * @bupkisAnchor date-like-to-be-the-same-date-as-date-like
+ * @bupkisAssertionCategory date
+ */
+export const sameDateAssertion = createAssertion([DateLikeFormatSchema, 'to be the same date as', DateLikeFormatSchema], (subject, other) => {
+    const subjectDate = toDate(subject);
+    const otherDate = toDate(other);
+    if (!subjectDate) {
+        return {
+            message: `Expected subject to be a valid date, but received: ${subject}`,
+        };
+    }
+    if (!otherDate) {
+        return {
+            message: `Expected comparison date to be a valid date, but received: ${other}`,
+        };
+    }
+    const isSameDate = subjectDate.getFullYear() === otherDate.getFullYear() &&
+        subjectDate.getMonth() === otherDate.getMonth() &&
+        subjectDate.getDate() === otherDate.getDate();
+    if (!isSameDate) {
+        return {
+            actual: subjectDate.toDateString(),
+            expected: otherDate.toDateString(),
+            message: `Expected dates to be the same day, but ${subjectDate.toDateString()} !== ${otherDate.toDateString()}`,
+        };
+    }
+});
+/**
+ * Asserts that the subject is equal to another date within a tolerance.
+ *
+ * @example
+ *
+ * ```ts
+ * const date1 = new Date('2023-01-01T10:00:00.000Z');
+ * const date2 = new Date('2023-01-01T10:00:00.500Z');
+ * expect(date1, 'to equal', date2, 'within', '1 second'); // passes
+ * expect(date1, 'to equal', date2, 'within', '100 milliseconds'); // fails
+ * ```
+ *
+ * @group Date/Time Assertions
+ * @bupkisAnchor date-like-to-equal-date-like-within-duration
+ * @bupkisAssertionCategory date
+ */
+export const equalWithinAssertion = createAssertion([
+    DateLikeFormatSchema,
+    'to equal',
+    DateLikeFormatSchema,
+    'within',
+    DurationFormatSchema,
+], (subject, other, toleranceStr) => {
+    const subjectDate = toDate(subject);
+    const otherDate = toDate(other);
+    if (!subjectDate) {
+        return {
+            message: `Expected subject to be a valid date, but received: ${subject}`,
+        };
+    }
+    if (!otherDate) {
+        return {
+            message: `Expected comparison date to be a valid date, but received: ${other}`,
+        };
+    }
+    // Transform the duration string to milliseconds
+    const durationResult = DurationSchema.safeParse(toleranceStr);
+    if (!durationResult.success) {
+        return {
+            message: `Expected a valid duration string, but received: ${toleranceStr}`,
+        };
+    }
+    const toleranceMs = durationResult.data;
+    const diff = abs(subjectDate.getTime() - otherDate.getTime());
+    if (diff > toleranceMs) {
+        return {
+            actual: { difference: diff },
+            expected: { maxDifference: toleranceMs },
+            message: `Expected dates to be equal within ${toleranceStr} (${toleranceMs}ms), but difference was ${diff}ms`,
+        };
+    }
+});
+/**
+ * Asserts that the subject is a weekend (Saturday or Sunday) in UTC.
+ *
+ * @example
+ *
+ * ```ts
+ * expect(new Date('2023-01-07'), 'to be a weekend'); // passes (Saturday in UTC)
+ * expect(new Date('2023-01-08'), 'to be a weekend'); // passes (Sunday in UTC)
+ * expect(new Date('2023-01-09'), 'to be a weekend'); // fails (Monday in UTC)
+ * ```
+ *
+ * @group Date/Time Assertions
+ * @bupkisAnchor unknown-to-be-a-weekend
+ * @bupkisAssertionCategory date
+ */
+export const weekendAssertion = createAssertion(['to be a weekend'], (subject) => {
+    const date = toDate(subject);
+    if (!date) {
+        return {
+            message: `Expected subject to be a valid date, but received: ${subject}`,
+        };
+    }
+    const day = date.getUTCDay();
+    const isWeekend = day === 0 || day === 6; // Sunday or Saturday
+    if (!isWeekend) {
+        return {
+            message: `Expected date to be a weekend (Saturday or Sunday in UTC), but it was ${DAY_NAMES[day]} in UTC`,
+        };
+    }
+});
+/**
+ * Asserts that the subject is a weekday (Monday through Friday) in UTC.
+ *
+ * @example
+ *
+ * ```ts
+ * expect(new Date('2023-01-09'), 'to be a weekday'); // passes (Monday in UTC)
+ * expect(new Date('2023-01-13'), 'to be a weekday'); // passes (Friday in UTC)
+ * expect(new Date('2023-01-07'), 'to be a weekday'); // fails (Saturday in UTC)
+ * ```
+ *
+ * @group Date/Time Assertions
+ * @bupkisAnchor unknown-to-be-a-weekday
+ * @bupkisAssertionCategory date
+ */
+export const weekdayAssertion = createAssertion(['to be a weekday'], (subject) => {
+    const date = toDate(subject);
+    if (!date) {
+        return {
+            message: `Expected subject to be a valid date, but received: ${subject}`,
+        };
+    }
+    const day = date.getUTCDay();
+    const isWeekday = day >= 1 && day <= 5; // Monday through Friday
+    if (!isWeekday) {
+        return {
+            message: `Expected date to be a weekday (Monday through Friday in UTC), but it was ${DAY_NAMES[day]} in UTC`,
+        };
+    }
+});
+//# sourceMappingURL=sync-date.js.map

package/dist/assertion/impl/sync-date.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sync-date.js","sourceRoot":"","sources":["../../../src/assertion/impl/sync-date.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,SAAS,EAAE,0BAA0B;AAC9C,OAAO,EACL,oBAAoB,EACpB,UAAU,EACV,oBAAoB,EACpB,cAAc,GACf,wBAAwB;AACzB,OAAO,EAAE,eAAe,EAAE,qBAAqB;AAE/C,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;AACzB,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;AAErB;;;;;GAKG;AACH,MAAM,MAAM,GAAG,CAAC,KAAc,EAAe,EAAE;IAC7C,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,MAAM,MAAM,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,OAAO,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC;IACjD,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,MAAM,MAAM,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,OAAO,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC;IACjD,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,eAAe,CAC/C,CAAC,CAAC,oBAAoB,EAAE,iBAAiB,CAAC,CAAC,EAC3C,oBAAoB,CACrB,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,eAAe,CAC5C,CAAC,oBAAoB,EAAE,cAAc,EAAE,oBAAoB,CAAC,EAC5D,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE;IACjB,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;IACpC,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAChC,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO;YACL,OAAO,EAAE,sDAAsD,OAAO,EAAE;SACzE,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO;YACL,OAAO,EAAE,8DAA8D,KAAK,EAAE;SAC/E,CAAC;IACJ,CAAC;IAED,0EAA0E;IAC1E,OAAO;QACL,MAAM,EAAE,UAAU,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC;QACzD,OAAO,EAAE,WAAW;KACrB,CAAC;AACJ,CAAC,CACF,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,eAAe,CAC3C,CAAC,oBAAoB,EAAE,aAAa,EAAE,oBAAoB,CAAC,EAC3D,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE;IACjB,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;IACpC,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAChC,IAAI,WAAW,KAAK,IAAI,EAAE,CAAC;QACzB,OAAO;YACL,OAAO,EAAE,sDAAsD,OAAO,EAAE;SACzE,CAAC;IACJ,CAAC;IACD,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;QACvB,OAAO;YACL,OAAO,EAAE,8DAA8D,KAAK,EAAE;SAC/E,CAAC;IACJ,CAAC;IAED,0EAA0E;IAC1E,OAAO;QACL,MAAM,EAAE,UAAU,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC;QACzD,OAAO,EAAE,WAAW;KACrB,CAAC;AACJ,CAAC,CACF,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,eAAe,CAC7C;IACE,oBAAoB;IACpB,eAAe;IACf,oBAAoB;IACpB,KAAK;IACL,oBAAoB;CACrB,EACD,CAAC,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;IACtB,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;IACpC,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAChC,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;IAC5B,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO;YACL,OAAO,EAAE,sDAAsD,OAAO,EAAE;SACzE,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO;YACL,OAAO,EAAE,yDAAyD,KAAK,EAAE;SAC1E,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO;YACL,OAAO,EAAE,uDAAuD,GAAG,EAAE;SACtE,CAAC;IACJ,CAAC;IAED,+EAA+E;IAC/E,OAAO;QACL,MAAM,EAAE,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC;QAC9C,OAAO,EAAE,WAAW;KACrB,CAAC;AACJ,CAAC,CACF,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAC9C,CAAC,oBAAoB,EAAE,wBAAwB,EAAE,oBAAoB,CAAC,EACtE,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE;IACjB,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;IACpC,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAChC,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO;YACL,OAAO,EAAE,sDAAsD,OAAO,EAAE;SACzE,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO;YACL,OAAO,EAAE,8DAA8D,KAAK,EAAE;SAC/E,CAAC;IACJ,CAAC;IAED,MAAM,UAAU,GACd,WAAW,CAAC,WAAW,EAAE,KAAK,SAAS,CAAC,WAAW,EAAE;QACrD,WAAW,CAAC,QAAQ,EAAE,KAAK,SAAS,CAAC,QAAQ,EAAE;QAC/C,WAAW,CAAC,OAAO,EAAE,KAAK,SAAS,CAAC,OAAO,EAAE,CAAC;IAEhD,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO;YACL,MAAM,EAAE,WAAW,CAAC,YAAY,EAAE;YAClC,QAAQ,EAAE,SAAS,CAAC,YAAY,EAAE;YAClC,OAAO,EAAE,0CAA0C,WAAW,CAAC,YAAY,EAAE,QAAQ,SAAS,CAAC,YAAY,EAAE,EAAE;SAChH,CAAC;IACJ,CAAC;AACH,CAAC,CACF,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,eAAe,CACjD;IACE,oBAAoB;IACpB,UAAU;IACV,oBAAoB;IACpB,QAAQ;IACR,oBAAoB;CACrB,EACD,CAAC,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,EAAE;IAC/B,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;IACpC,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAChC,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO;YACL,OAAO,EAAE,sDAAsD,OAAO,EAAE;SACzE,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO;YACL,OAAO,EAAE,8DAA8D,KAAK,EAAE;SAC/E,CAAC;IACJ,CAAC;IAED,gDAAgD;IAChD,MAAM,cAAc,GAAG,cAAc,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;IAC9D,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC;QAC5B,OAAO;YACL,OAAO,EAAE,mDAAmD,YAAY,EAAE;SAC3E,CAAC;IACJ,CAAC;IACD,MAAM,WAAW,GAAG,cAAc,CAAC,IAAI,CAAC;IAExC,MAAM,IAAI,GAAG,GAAG,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG,SAAS,CAAC,OAAO,EAAE,CAAC,CAAC;IAC9D,IAAI,IAAI,GAAG,WAAW,EAAE,CAAC;QACvB,OAAO;YACL,MAAM,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE;YAC5B,QAAQ,EAAE,EAAE,aAAa,EAAE,WAAW,EAAE;YACxC,OAAO,EAAE,qCAAqC,YAAY,KAAK,WAAW,2BAA2B,IAAI,IAAI;SAC9G,CAAC;IACJ,CAAC;AACH,CAAC,CACF,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,eAAe,CAC7C,CAAC,iBAAiB,CAAC,EACnB,CAAC,OAAO,EAAE,EAAE;IACV,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;IAC7B,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO;YACL,OAAO,EAAE,sDAAsD,OAAO,EAAE;SACzE,CAAC;IACJ,CAAC;IAED,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;IAC7B,MAAM,SAAS,GAAG,GAAG,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,qBAAqB;IAE/D,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO;YACL,OAAO,EAAE,yEAAyE,SAAS,CAAC,GAAG,CAAC,SAAS;SAC1G,CAAC;IACJ,CAAC;AACH,CAAC,CACF,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,eAAe,CAC7C,CAAC,iBAAiB,CAAC,EACnB,CAAC,OAAO,EAAE,EAAE;IACV,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;IAC7B,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO;YACL,OAAO,EAAE,sDAAsD,OAAO,EAAE;SACzE,CAAC;IACJ,CAAC;IAED,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;IAC7B,MAAM,SAAS,GAAG,GAAG,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,wBAAwB;IAEhE,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO;YACL,OAAO,EAAE,4EAA4E,SAAS,CAAC,GAAG,CAAC,SAAS;SAC7G,CAAC;IACJ,CAAC;AACH,CAAC,CACF,CAAC"}