@nowline/layout 0.8.6 → 0.10.0

package/dist/working-calendar.d.ts

@@ -1,14 +1,138 @@
-import type { CalendarConfig } from './calendar.js';
+import type { CalendarConfig, CalendarMode } from './calendar.js';
 import type { ScaleUnit } from './view-preset.js';
+/**
+ * One `non-working` (or working-exception) declaration. Kinds:
+ * `dates`, or `start` + `end` without `every`, is a dated rule; `every` with
+ * `start` and/or `end` is a bounded recurrence (open on an omitted side);
+ * `every` alone is the open-ended week. All dates are UTC midnight.
+ */
+export interface CalendarRule {
+    /** False: weekend, holiday, closure. True: a working exception. */
+    working: boolean;
+    /** Recurring UTC weekdays (0 = Sunday … 6 = Saturday). */
+    every?: ReadonlySet<number>;
+    /** Specific dates (`date:` single or list); excludes `every` / `start` / `end`. */
+    dates?: ReadonlyArray<Date>;
+    /** Range start, or recurrence window start; inclusive. */
+    start?: Date;
+    /** Range end, or recurrence window end; inclusive. */
+    end?: Date;
+    id?: string;
+    title?: string;
+}
+/** A maximal run of consecutive non-working dates. */
+export interface NonWorkingRun {
+    /** First non-working date of the run (UTC midnight). */
+    from: Date;
+    /** Last non-working date of the run, inclusive. */
+    through: Date;
+    /** Titles of the dated non-working rules inside it; empty for a plain weekend. */
+    titles: string[];
+}
+/**
+ * A maximal run of consecutive days that titled dated `working` rules turn
+ * from non-working to working (specs/working-calendar.md §7.4): days a
+ * dated closure, a bounded recurrence or the open-ended week would close.
+ */
+export interface WorkingExceptionRun {
+    /** First day of the run (UTC midnight). */
+    from: Date;
+    /** Last day of the run (UTC midnight), inclusive. */
+    through: Date;
+    /** Titles of the titled dated working rules that turn a day of it, never empty. */
+    titles: string[];
+}
 export interface WorkingCalendar {
     /** Days per `1<unit>` literal (e.g. `1w` → 5 for business). */
     daysPerUnit(unit: ScaleUnit): number;
-    /** Move forward by N units (e.g. `addUnits(d, 2, 'weeks')`). */
+    /** `dateAtWorkingIndex(date, count × daysPerUnit(unit))`. */
     addUnits(date: Date, count: number, unit: ScaleUnit): Date;
-    /** True when the given date is a working day in this calendar. */
+    /** False: every function below is plain calendar-day math. */
+    readonly hasNonWorkingDays: boolean;
+    /** True when the given date is a working day; an invalid date counts as working. */
     isWorkingDay(date: Date): boolean;
+    /**
+     * Working days in [base, date), signed. A non-working `date` counts as the
+     * next working day. `base` must be UTC midnight.
+     */
+    workingIndexOf(base: Date, date: Date): number;
+    /**
+     * UTC midnight of the working day with this index from `base` (fractions
+     * floor). Index 0 is the first working day at or after `base`, which must
+     * be UTC midnight.
+     */
+    dateAtWorkingIndex(base: Date, index: number): Date;
+    /** Maximal non-working runs intersecting [from, to), extended past both ends. */
+    nonWorkingRuns(from: Date, to: Date): NonWorkingRun[];
+    /** Working-exception runs intersecting [from, to), with their real dates. */
+    workingExceptionRuns(from: Date, to: Date): WorkingExceptionRun[];
+    /**
+     * First working weekday after the longest recurring non-working run of the
+     * open-ended week (Sat–Sun → Monday); undefined without one.
+     */
+    readonly weekStart: number | undefined;
+    /**
+     * Weekdays the open-ended week works (0 = Sunday … 6 = Saturday): the
+     * weekly pattern an exporter writes as its base calendar. Dated rules and
+     * bounded recurrences are exceptions to it and never change it.
+     */
+    readonly workingWeekdays: ReadonlySet<number>;
+    /** Normalized copies of the valid rules, in input order. */
+    readonly rules: ReadonlyArray<CalendarRule>;
 }
-export declare function fromCalendarConfig(cal: CalendarConfig): WorkingCalendar;
+/** The rules a calendar preset implies: the weekend for business, nothing otherwise. */
+export declare function presetRules(mode: CalendarMode): CalendarRule[];
+/**
+ * Build the working calendar for a resolved `CalendarConfig`. `rules`
+ * defaults to the preset's (the weekend for business). Malformed rules are
+ * dropped silently because included files are parsed without validation;
+ * throws `RangeError` for a weekday outside 0..6 or an unbounded stretch
+ * with no working weekday.
+ */
+export declare function fromCalendarConfig(cal: CalendarConfig, rules?: ReadonlyArray<CalendarRule>): WorkingCalendar;
+/** Every day is a working day; units use the full-calendar day counts. */
 export declare function continuousCalendar(): WorkingCalendar;
+/**
+ * The exclusive end date of a span of working-day indices [s, e) from
+ * `base` (specs/working-calendar.md §5.2): the day after the last whole
+ * working day the span covers, so a Mon–Fri item ends on Saturday. A span
+ * covering no whole working day ends on its start date. Indices floor, as
+ * in `dateAtWorkingIndex`.
+ *
+ * On the identity path it is `addDays(base, e)`, truncation included, so
+ * calendar-day spans keep their exact dates.
+ */
+export declare function spanEndDate(calendar: WorkingCalendar, base: Date, s: number, e: number): Date;
+/**
+ * A maximal run of consecutive days on which the calendar differs from its
+ * open-ended week (specs/working-calendar.md §8): a holiday, a closure, a
+ * bounded recurrence's closed days, or a working day inside a closed weekend.
+ * The MS Project `<Exceptions>` and the Mermaid dated `excludes` both read it.
+ */
+export interface CalendarException {
+    /** First day of the run (UTC midnight). */
+    from: Date;
+    /** Last day of the run (UTC midnight), inclusive. */
+    through: Date;
+    /** True: a working day the open week closes. False: a closure the open week works. */
+    working: boolean;
+    /** Titles of the dated or ranged rules behind it; omitted when there are none. */
+    titles?: string[];
+}
+/**
+ * The days in the horizon whose working state differs from the open-ended
+ * week (`workingWeekdays`), as maximal runs split wherever the state flips.
+ *
+ * The horizon is [from, to) together with every finite bound of every rule:
+ * its `dates`, and its `start` / `end` when set. A half-open bounded
+ * recurrence is therefore expanded only inside that horizon, so a declared
+ * holiday outside the roadmap window is still listed and nothing iterates
+ * forever. Titles come from the dated or ranged rules (no `every`) whose
+ * `working` equals the run's state and that cover a day of it, in
+ * `working.rules` order, de-duplicated.
+ */
+export declare function calendarExceptions(working: WorkingCalendar, from: Date, to: Date): CalendarException[];
 export declare function daysPerUnit(unit: ScaleUnit, cal: CalendarConfig): number;
+/** Calendar days per `1<unit>` when every day counts (`calendar:full`). */
+export declare function continuousDaysPerUnit(unit: ScaleUnit): number;
 //# sourceMappingURL=working-calendar.d.ts.map

package/dist/working-calendar.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"working-calendar.d.ts","sourceRoot":"","sources":["../src/working-calendar.ts"],"names":[],"mappings":"AAcA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAEpD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAElD,MAAM,WAAW,eAAe;IAC5B,+DAA+D;IAC/D,WAAW,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,CAAC;IACrC,gEAAgE;IAChE,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,GAAG,IAAI,CAAC;IAC3D,kEAAkE;IAClE,YAAY,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC;CACrC;AAED,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,cAAc,GAAG,eAAe,CAUvE;AAED,wBAAgB,kBAAkB,IAAI,eAAe,CAgCpD;AAED,wBAAgB,WAAW,CAAC,IAAI,EAAE,SAAS,EAAE,GAAG,EAAE,cAAc,GAAG,MAAM,CAExE"}
+{"version":3,"file":"working-calendar.d.ts","sourceRoot":"","sources":["../src/working-calendar.ts"],"names":[],"mappings":"AA0BA,OAAO,KAAK,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAElE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAElD;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IACzB,mEAAmE;IACnE,OAAO,EAAE,OAAO,CAAC;IACjB,0DAA0D;IAC1D,KAAK,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAC5B,mFAAmF;IACnF,KAAK,CAAC,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC;IAC5B,0DAA0D;IAC1D,KAAK,CAAC,EAAE,IAAI,CAAC;IACb,sDAAsD;IACtD,GAAG,CAAC,EAAE,IAAI,CAAC;IACX,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,sDAAsD;AACtD,MAAM,WAAW,aAAa;IAC1B,wDAAwD;IACxD,IAAI,EAAE,IAAI,CAAC;IACX,mDAAmD;IACnD,OAAO,EAAE,IAAI,CAAC;IACd,kFAAkF;IAClF,MAAM,EAAE,MAAM,EAAE,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAChC,2CAA2C;IAC3C,IAAI,EAAE,IAAI,CAAC;IACX,qDAAqD;IACrD,OAAO,EAAE,IAAI,CAAC;IACd,mFAAmF;IACnF,MAAM,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,eAAe;IAC5B,+DAA+D;IAC/D,WAAW,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,CAAC;IACrC,6DAA6D;IAC7D,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,GAAG,IAAI,CAAC;IAC3D,8DAA8D;IAC9D,QAAQ,CAAC,iBAAiB,EAAE,OAAO,CAAC;IACpC,oFAAoF;IACpF,YAAY,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC;IAClC;;;OAGG;IACH,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,GAAG,MAAM,CAAC;IAC/C;;;;OAIG;IACH,kBAAkB,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACpD,iFAAiF;IACjF,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,GAAG,aAAa,EAAE,CAAC;IACtD,6EAA6E;IAC7E,oBAAoB,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,GAAG,mBAAmB,EAAE,CAAC;IAClE;;;OAGG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC;;;;OAIG;IACH,QAAQ,CAAC,eAAe,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAC9C,4DAA4D;IAC5D,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;CAC/C;AAED,wFAAwF;AACxF,wBAAgB,WAAW,CAAC,IAAI,EAAE,YAAY,GAAG,YAAY,EAAE,CAG9D;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAC9B,GAAG,EAAE,cAAc,EACnB,KAAK,GAAE,aAAa,CAAC,YAAY,CAAyB,GAC3D,eAAe,CAEjB;AAED,0EAA0E;AAC1E,wBAAgB,kBAAkB,IAAI,eAAe,CAEpD;AAED;;;;;;;;;GASG;AACH,wBAAgB,WAAW,CAAC,QAAQ,EAAE,eAAe,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI,CAK7F;AAED;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAC9B,2CAA2C;IAC3C,IAAI,EAAE,IAAI,CAAC;IACX,qDAAqD;IACrD,OAAO,EAAE,IAAI,CAAC;IACd,sFAAsF;IACtF,OAAO,EAAE,OAAO,CAAC;IACjB,kFAAkF;IAClF,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAC9B,OAAO,EAAE,eAAe,EACxB,IAAI,EAAE,IAAI,EACV,EAAE,EAAE,IAAI,GACT,iBAAiB,EAAE,CA+CrB;AAwBD,wBAAgB,WAAW,CAAC,IAAI,EAAE,SAAS,EAAE,GAAG,EAAE,cAAc,GAAG,MAAM,CAExE;AAiBD,2EAA2E;AAC3E,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,CAa7D"}