slotlock 0.1.1 → 0.3.0

package/sync.d.ts

@@ -89,13 +89,19 @@ export declare class CalendarContractError extends Error {
 export declare class CalendarExpansionLimitError extends CalendarContractError {
     constructor();
 }
+/**
+ * Why Slotlock refuses `rule`, in words, or null when it expands it: not RFC 5545 §3.3.10 as
+ * canonicalRecurrenceRule reads it, or a shape ical.js expands wrongly (recurShapeProblem).
+ */
+export declare function recurrenceRuleProblem(rule: string): string | null;
 /**
  * A recurrence rule as RFC 5545 §3.3.10 writes it, in ical.js's canonical spelling, or `null`.
  * ical.js accepts more than it should: it drops unknown parts, lets a repeated part replace the
  * first, reads `COUNT=3X` as 3 and `COUNT=0` as no count at all. So every part must be one RFC 5545
  * names, appear once and match its grammar, with FREQ present and never UNTIL and COUNT together,
  * and the parts RFC 5545 forbids for a frequency (BYWEEKNO but YEARLY, BYYEARDAY with DAILY, WEEKLY
- * or MONTHLY, BYMONTHDAY with WEEKLY, a numbered BYDAY but MONTHLY or YEARLY) are refused.
+ * or MONTHLY, BYMONTHDAY with WEEKLY, a numbered BYDAY but MONTHLY or YEARLY) are refused. The
+ * numeric BY lists come back in ascending order (sortRuleParts).
  */
 export declare function canonicalRecurrenceRule(rule: string): string | null;
 /**
@@ -142,8 +148,34 @@ export declare function icalendarPropertyHead(line: string, params: Record<strin
     parameters: number;
     end: number;
 };
-/** Parse VEVENTs with the standards library; event content is deliberately discarded. */
+/**
+ * Parse VEVENTs with the standards library; event content is deliberately discarded. All or
+ * nothing: a series Slotlock cannot read refuses the whole calendar, so a caller that reads the
+ * result as the calendar's busy time never takes a refused series' time as free. To keep the rest
+ * of a calendar when one series is refused, use parseICalendarFeed.
+ */
 export declare function parseICalendarChanges(input: string, calendarTimezone?: string, expansionWindow?: ICalendarExpansionWindow): ExternalCalendarChange[];
+/** A series a feed holds that Slotlock refused to read, by its UID. */
+export interface ICalendarSeriesRefusal {
+    uid: string;
+    code: CalendarContractError['code'];
+    /** Set when the series needs more work than Slotlock spends (CalendarExpansionLimitError). */
+    limit?: true;
+}
+/** What parseICalendarFeed read: every series it could, and the ones it refused. */
+export interface ICalendarFeedRead {
+    changes: ExternalCalendarChange[];
+    /** Their time is not known: treat it as busy, or the feed's coverage as incomplete. */
+    refused: ICalendarSeriesRefusal[];
+}
+/**
+ * parseICalendarChanges, refusing one series at a time: a series Slotlock cannot read (a rule
+ * shape ical.js expands wrongly, an event whose end the clocks move before its start, DTEND with
+ * DURATION, or one that needs more than its budget) is named in `refused` and the rest of the
+ * calendar is read. A calendar that is not one (its size, its time zones, a missing UID, a window
+ * past 367 days) is still refused whole, with CalendarContractError.
+ */
+export declare function parseICalendarFeed(input: string, calendarTimezone?: string, expansionWindow?: ICalendarExpansionWindow): ICalendarFeedRead;
 /** Deterministic RFC 5545 + iTIP payload, validated by the installed ical.js implementation. */
 export declare function emitITipCalendar(input: ICalendarEvent, method: ITipMethod): string;
 /** Backwards-compatible feed helper. Cancellation maps to iTIP CANCEL. */
@@ -178,4 +210,13 @@ export declare function expandCalendarEventSeries(input: CalendarEventContent, w
     /** Refuse (CalendarExpansionLimitError) instead of searching from the start without a cursor. */
     resumeOnly?: boolean;
 }): CalendarSeriesExpansion;
+/**
+ * Why this Slotlock refuses an event an earlier one stored, in words, or null when it expands it.
+ * Maintenance counts such a series as refused on every roll and leaves it its old coverage: a rule
+ * shape ical.js expands wrongly (recurrenceRuleProblem), COUNT with a yearly day some years lack, a
+ * rule it no longer stores at all, or exceptions that name no occurrence (searched from the series'
+ * start to the last of them, within a roll's budget). It writes nothing, so it can be run over
+ * stored events before an upgrade.
+ */
+export declare function storedCalendarEventProblem(event: CalendarEventContent): string | null;
 export {};