@craftguild/jscalendar 0.4.0 → 0.5.0

package/dist/jscal.d.ts

@@ -6,9 +6,9 @@ import { TaskObject } from "./jscal/task.js";
 import { GroupObject } from "./jscal/group.js";
 import { createId, createUid } from "./jscal/ids.js";
 import { isEvent, isGroup, isTask } from "./jscal/guards.js";
-import { buildAlert, buildAbsoluteTrigger, buildLink, buildLocation, buildNDay, buildOffsetTrigger, buildParticipants, buildRecurrenceRule, buildRelation, buildRelatedTo, buildTimeZone, buildTimeZoneMap, buildTimeZoneRule, buildVirtualLocation, buildVirtualLocations, buildLocations, buildLinks, buildParticipant, buildAlerts } from "./jscal/builders.js";
+import { buildAlert, buildAbsoluteTrigger, buildEventPatch, buildLink, buildLocation, buildNDay, buildOffsetTrigger, buildParticipants, buildRecurrenceRule, buildRelation, buildRelatedTo, buildTimeZone, buildTimeZoneMap, buildTimeZoneRule, buildVirtualLocation, buildVirtualLocations, buildLocations, buildLinks, buildParticipant, buildAlerts, buildTaskPatch, buildGroupPatch } from "./jscal/builders.js";
 export type { CreateOptions, UpdateOptions } from "./jscal/types.js";
-export type { AlertInput, AbsoluteTriggerInput, LinkInput, LocationInput, NDayInput, OffsetTriggerInput, ParticipantInput, RecurrenceRuleInput, RelationInput, TimeZoneInput, TimeZoneRuleInput, VirtualLocationInput, } from "./jscal/builders.js";
+export type { AlertInput, AbsoluteTriggerInput, EventPatchInput, GroupPatchInput, IdValueInput, LinkInput, LocationInput, NDayInput, OffsetTriggerInput, ParticipantInput, RecurrenceRuleInput, RelationInput, TaskPatchInput, TimeZoneInput, TimeZoneRuleInput, VirtualLocationInput, } from "./jscal/builders.js";
 export { createId, createUid, isEvent, isGroup, isTask };
 export declare const JsCal: {
     Event: typeof EventObject;
@@ -16,6 +16,9 @@ export declare const JsCal: {
     Group: typeof GroupObject;
     createUid: typeof createUid;
     createId: typeof createId;
+    isEvent: typeof isEvent;
+    isGroup: typeof isGroup;
+    isTask: typeof isTask;
     duration: {
         seconds(value: number): string;
         minutes(value: number): string;
@@ -43,6 +46,10 @@ export declare const JsCal: {
     TimeZoneRule: typeof buildTimeZoneRule;
     RecurrenceRule: typeof buildRecurrenceRule;
     NDay: typeof buildNDay;
+    ByDay: typeof buildNDay;
+    EventPatch: typeof buildEventPatch;
+    TaskPatch: typeof buildTaskPatch;
+    GroupPatch: typeof buildGroupPatch;
     participants: typeof buildParticipants;
     locations: typeof buildLocations;
     virtualLocations: typeof buildVirtualLocations;

package/dist/jscal.js

@@ -10,7 +10,7 @@ import { Duration } from "./jscal/duration.js";
 import { createId, createUid } from "./jscal/ids.js";
 import { normalizeItems, normalizeToObjects } from "./jscal/normalize.js";
 import { isEvent, isGroup, isTask } from "./jscal/guards.js";
-import { buildAlert, buildAbsoluteTrigger, buildLink, buildLocation, buildNDay, buildOffsetTrigger, buildParticipants, buildRecurrenceRule, buildRelation, buildRelatedTo, buildTimeZone, buildTimeZoneMap, buildTimeZoneRule, buildVirtualLocation, buildVirtualLocations, buildLocations, buildLinks, buildParticipant, buildAlerts, } from "./jscal/builders.js";
+import { buildAlert, buildAbsoluteTrigger, buildEventPatch, buildLink, buildLocation, buildNDay, buildOffsetTrigger, buildParticipants, buildRecurrenceRule, buildRelation, buildRelatedTo, buildTimeZone, buildTimeZoneMap, buildTimeZoneRule, buildVirtualLocation, buildVirtualLocations, buildLocations, buildLinks, buildParticipant, buildAlerts, buildTaskPatch, buildGroupPatch, } from "./jscal/builders.js";
 export { createId, createUid, isEvent, isGroup, isTask };
 export const JsCal = {
     Event: EventObject,
@@ -18,6 +18,9 @@ export const JsCal = {
     Group: GroupObject,
     createUid,
     createId,
+    isEvent,
+    isGroup,
+    isTask,
     duration: Duration,
     timeZone: resolveTimeZone,
     timeZones: TimeZones,
@@ -34,6 +37,11 @@ export const JsCal = {
     TimeZoneRule: buildTimeZoneRule,
     RecurrenceRule: buildRecurrenceRule,
     NDay: buildNDay,
+    // Alias for NDay to better mirror the byDay naming in recurrence rules.
+    ByDay: buildNDay,
+    EventPatch: buildEventPatch,
+    TaskPatch: buildTaskPatch,
+    GroupPatch: buildGroupPatch,
     participants: buildParticipants,
     locations: buildLocations,
     virtualLocations: buildVirtualLocations,

package/dist/patch.d.ts

@@ -1,4 +1,4 @@
-import type { PatchObject } from "./types.js";
+import type { PatchLike } from "./types.js";
 /**
  * Error thrown when a patch operation is invalid.
  */
@@ -15,4 +15,4 @@ export declare class PatchError extends Error {
  * @param patch Patch object to apply.
  * @return Patched clone of the input object.
  */
-export declare function applyPatch<T extends object>(input: T, patch: PatchObject): T;
+export declare function applyPatch<T extends object>(input: T, patch: PatchLike): T;

package/dist/recurrence/expand.d.ts

@@ -1,7 +1,7 @@
 import type { JSCalendarObject } from "../types.js";
 import type { RecurrenceRange } from "./types.js";
 /**
- * Expand recurrence into occurrences.
+ * Expand recurrence into occurrences sorted by recurrenceId/start.
  * @param items JSCalendar objects to expand.
  * @param range Date range bounds.
  * @return Generator of expanded occurrences.

package/dist/recurrence/expand.js

@@ -3,22 +3,43 @@ import { dateTimeInTimeZone, localDateTimeFromDate, localDateTimeToUtcDate } fro
 import { TYPE_EVENT, TYPE_TASK } from "./constants.js";
 import { expandRule } from "./rules.js";
 /**
- * Expand recurrence into occurrences.
+ * Expand recurrence into occurrences sorted by recurrenceId/start.
  * @param items JSCalendar objects to expand.
  * @param range Date range bounds.
  * @return Generator of expanded occurrences.
  */
 export function* expandRecurrence(items, range) {
+    const occurrences = [];
+    let index = 0;
     for (const item of items) {
         if (item["@type"] === TYPE_EVENT) {
-            yield* expandEvent(item, range);
-        }
-        else if (item["@type"] === TYPE_TASK) {
-            yield* expandTask(item, range);
+            for (const occurrence of expandEvent(item, range)) {
+                occurrences.push({ value: occurrence, key: occurrenceKey(occurrence), index });
+                index += 1;
+            }
+            continue;
         }
-        else {
-            yield item;
+        if (item["@type"] === TYPE_TASK) {
+            for (const occurrence of expandTask(item, range)) {
+                occurrences.push({ value: occurrence, key: occurrenceKey(occurrence), index });
+                index += 1;
+            }
+            continue;
         }
+        occurrences.push({ value: item, key: occurrenceKey(item), index });
+        index += 1;
+    }
+    occurrences.sort((a, b) => {
+        if (a.key && b.key)
+            return a.key.localeCompare(b.key);
+        if (a.key)
+            return -1;
+        if (b.key)
+            return 1;
+        return a.index - b.index;
+    });
+    for (const occurrence of occurrences) {
+        yield occurrence.value;
     }
 }
 /**

package/dist/types.d.ts

@@ -12,7 +12,30 @@ export type JsonPrimitive = string | number | boolean | null;
 export type JsonValue = JsonPrimitive | JsonValue[] | {
     [key: string]: JsonValue;
 };
-export type PatchObject = Record<string, JsonValue | null>;
+export type PatchValue = JsonValue | null;
+export interface PatchObject {
+    [key: string]: PatchValue;
+}
+type PatchFields<T> = {
+    [K in keyof Omit<T, "@type">]?: T[K] | null;
+};
+type PatchTag<TTag extends string> = {
+    __patchType?: TTag;
+};
+export type EventPatch = PatchFields<Event> & PatchTag<"Event">;
+export type TaskPatch = PatchFields<Task> & PatchTag<"Task">;
+export type GroupPatch = PatchFields<Group> & PatchTag<"Group">;
+export type ParticipantPatch = PatchFields<Participant>;
+export type LocationPatch = PatchFields<Location>;
+export type VirtualLocationPatch = PatchFields<VirtualLocation>;
+export type AlertPatch = PatchFields<Alert>;
+export type RelationPatch = PatchFields<Relation>;
+export type LinkPatch = PatchFields<Link>;
+export type TimeZonePatch = PatchFields<TimeZone>;
+export type TimeZoneRulePatch = PatchFields<TimeZoneRule>;
+export type RecurrenceRulePatch = PatchFields<RecurrenceRule>;
+export type NDayPatch = PatchFields<NDay>;
+export type PatchLike = PatchObject | EventPatch | TaskPatch | GroupPatch | TimeZoneRulePatch;
 export interface Relation {
     "@type": "Relation";
     relation?: BooleanMap;
@@ -124,7 +147,7 @@ export interface TimeZoneRule {
     offsetFrom: string;
     offsetTo: string;
     recurrenceRules?: RecurrenceRule[];
-    recurrenceOverrides?: Record<LocalDateTime, PatchObject>;
+    recurrenceOverrides?: Record<LocalDateTime, TimeZoneRulePatch>;
     names?: BooleanMap;
     comments?: string[];
 }
@@ -162,7 +185,6 @@ export interface JSCalendarCommon {
     recurrenceIdTimeZone?: TimeZoneId | null;
     recurrenceRules?: RecurrenceRule[];
     excludedRecurrenceRules?: RecurrenceRule[];
-    recurrenceOverrides?: Record<LocalDateTime, PatchObject>;
     excluded?: boolean;
     priority?: Int;
     freeBusyStatus?: string;
@@ -173,7 +195,6 @@ export interface JSCalendarCommon {
     requestStatus?: string;
     useDefaultAlerts?: boolean;
     alerts?: Record<Id, Alert>;
-    localizations?: Record<string, PatchObject>;
     timeZone?: TimeZoneId | null;
     timeZones?: Partial<Record<TimeZoneId, TimeZone>>;
 }
@@ -182,6 +203,8 @@ export interface Event extends JSCalendarCommon {
     start: LocalDateTime;
     duration?: Duration;
     status?: string;
+    localizations?: Record<string, EventPatch>;
+    recurrenceOverrides?: Record<LocalDateTime, EventPatch>;
 }
 export interface Task extends JSCalendarCommon {
     "@type": "Task";
@@ -191,11 +214,15 @@ export interface Task extends JSCalendarCommon {
     percentComplete?: UnsignedInt;
     progress?: string;
     progressUpdated?: UTCDateTime;
+    localizations?: Record<string, TaskPatch>;
+    recurrenceOverrides?: Record<LocalDateTime, TaskPatch>;
 }
 export interface Group extends JSCalendarCommon {
     "@type": "Group";
     entries: Array<Event | Task>;
     source?: string;
+    localizations?: Record<string, GroupPatch>;
+    recurrenceOverrides?: Record<LocalDateTime, GroupPatch>;
 }
 export type JSCalendarObject = Event | Task | Group;
 export type CalendarType = JSCalendarObject["@type"];

package/dist/validate/asserts.d.ts

@@ -1,4 +1,4 @@
-import type { JsonValue, PatchObject } from "../types.js";
+import type { JsonValue, PatchLike } from "../types.js";
 /**
  * Get the UTF-8 byte length of a string.
  * @param value Input string.
@@ -152,4 +152,4 @@ export declare function assertJsonValue(value: JsonValue | object | null | undef
  * @param path Validation path.
  * @return Nothing.
  */
-export declare function assertPatchObject(value: PatchObject | undefined, path: string): void;
+export declare function assertPatchObject(value: PatchLike | undefined, path: string): void;

package/dist/validate/validators-common.js

@@ -191,8 +191,13 @@ export function validateParticipant(value, path) {
         }
     }
     assertString(value.kind, `${path}.kind`);
-    if (value.roles)
-        assertBooleanMap(value.roles, `${path}.roles`);
+    if (!value.roles) {
+        fail(`${path}.roles`, "is required");
+    }
+    assertBooleanMap(value.roles, `${path}.roles`);
+    if (Object.keys(value.roles).length === 0) {
+        fail(`${path}.roles`, "must include at least one role");
+    }
     assertId(value.locationId, `${path}.locationId`);
     assertString(value.language, `${path}.language`);
     assertString(value.participationStatus, `${path}.participationStatus`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@craftguild/jscalendar",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "RFC 8984 (JSCalendar) data model helpers for TypeScript",
   "type": "module",
   "main": "dist/index.js",