@sprucelabs/calendar-utils 36.0.29 → 36.1.1

package/build/esm/index.d.ts

@@ -17,6 +17,7 @@ export { default as eventTimeBlockSchema } from './.spruce/schemas/calendarUtils
 export { default as calendarEventLineIconSchema } from './.spruce/schemas/calendarUtils/v2021_05_19/calendarEventLineIcon.schema';
 export { default as DateParser } from './parsing/DateParser';
 export { default as sortTimezoneChoices } from './utilities/sortTimezoneChoices';
+export { default as RepeatingRuleTextGenerator } from './utilities/RepeatingRuleTextGenerator';
 export * from './dates';
 export { SpruceSchemas } from "./.spruce/schemas/schemas.types";
 export * from './constants';

package/build/esm/index.js

@@ -17,5 +17,6 @@ export { default as eventTimeBlockSchema } from './.spruce/schemas/calendarUtils
 export { default as calendarEventLineIconSchema } from './.spruce/schemas/calendarUtils/v2021_05_19/calendarEventLineIcon.schema.js';
 export { default as DateParser } from './parsing/DateParser.js';
 export { default as sortTimezoneChoices } from './utilities/sortTimezoneChoices.js';
+export { default as RepeatingRuleTextGenerator } from './utilities/RepeatingRuleTextGenerator.js';
 export * from './dates.js';
 export * from './constants.js';

package/build/esm/types/calendar.types.d.ts

@@ -14,6 +14,7 @@ export type CalendarEvent = SpruceSchemas.CalendarUtils.v2021_05_19.CalendarEven
 export type DayOfWeek = NonNullable<CalendarEvent['daysOfWeek']>[number];
 export type TimezoneChoices = typeof timezoneChoices;
 export type TimezoneName = TimezoneChoices[number]['value'];
+export type Repeats = NonNullable<CalendarEvent['repeats']>;
 export type Locale = Pick<LocaleImpl, 'on' | 'getZoneName' | 'offsetMinutesToZoneName' | 'getTimezoneOffsetMinutes' | 'setTimezoneOffsetMinutes' | 'setZoneName' | 'zoneNameToOffsetMinutes'>;
 export type SorterCalendarEvent = {
     id: string;

package/build/esm/utilities/RepeatingRuleTextGenerator.d.ts

@@ -0,0 +1,11 @@
+import { CalendarEvent, DateUtil } from '../types/calendar.types';
+export default class RepeatingRuleTextGenerator {
+    private unitMap;
+    private downMap;
+    private dates;
+    private constructor();
+    static Generator(options: {
+        dates: DateUtil;
+    }): RepeatingRuleTextGenerator;
+    generate(event: Pick<CalendarEvent, 'repeats' | 'interval' | 'daysOfWeek' | 'occurrences' | 'repeatsUntil'>): string;
+}

package/build/esm/utilities/RepeatingRuleTextGenerator.js

@@ -0,0 +1,51 @@
+import { assertOptions } from '@sprucelabs/schema';
+export default class RepeatingRuleTextGenerator {
+    constructor(dates) {
+        this.unitMap = {
+            daily: 'days',
+            weekly: 'weeks',
+            monthly: 'months',
+        };
+        this.downMap = {
+            sun: 'Sundays',
+            mon: 'Mondays',
+            tue: 'Tuesdays',
+            wed: 'Wednesdays',
+            thur: 'Thursdays',
+            fri: 'Fridays',
+            sat: 'Saturdays',
+        };
+        this.dates = dates;
+    }
+    static Generator(options) {
+        const { dates } = assertOptions(options, ['dates']);
+        return new this(dates);
+    }
+    generate(event) {
+        const { repeats, repeatsUntil, interval, daysOfWeek, occurrences } = event;
+        let message = '';
+        if (repeats) {
+            if (daysOfWeek) {
+                message = `Repeats weekly on ${daysOfWeek
+                    .map((d) => this.downMap[d])
+                    .join(', ')}`;
+            }
+            else if ((interval !== null && interval !== void 0 ? interval : 0) > 1) {
+                message = `Repeats every ${interval} ${this.unitMap[repeats]}`;
+            }
+            else {
+                message = `Repeats ${repeats}`;
+            }
+            if (occurrences) {
+                message += ` for ${occurrences} times.`;
+            }
+            else if (repeatsUntil) {
+                message += ` until ${this.dates.formatDate(repeatsUntil)}.`;
+            }
+            else {
+                message += ` forever.`;
+            }
+        }
+        return message;
+    }
+}

package/build/index.d.ts

@@ -17,6 +17,7 @@ export { default as eventTimeBlockSchema } from './.spruce/schemas/calendarUtils
 export { default as calendarEventLineIconSchema } from './.spruce/schemas/calendarUtils/v2021_05_19/calendarEventLineIcon.schema';
 export { default as DateParser } from './parsing/DateParser';
 export { default as sortTimezoneChoices } from './utilities/sortTimezoneChoices';
+export { default as RepeatingRuleTextGenerator } from './utilities/RepeatingRuleTextGenerator';
 export * from './dates';
 export { SpruceSchemas } from "./.spruce/schemas/schemas.types";
 export * from './constants';

package/build/index.js

@@ -17,7 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sortTimezoneChoices = exports.DateParser = exports.calendarEventLineIconSchema = exports.eventTimeBlockSchema = exports.eventExclusionDateSchema = exports.calendarEventTargetSchema = exports.calendarEventSchema = exports.calculateEventDurationMinutes = exports.calculateEventDurationMillis = exports.TimezoneChoiceSorter = exports.DateUtilDecorator = exports.LocaleImpl = exports.PeopleSorter = exports.durationUtil = exports.dateUtil = exports.calendarUtil = void 0;
+exports.RepeatingRuleTextGenerator = exports.sortTimezoneChoices = exports.DateParser = exports.calendarEventLineIconSchema = exports.eventTimeBlockSchema = exports.eventExclusionDateSchema = exports.calendarEventTargetSchema = exports.calendarEventSchema = exports.calculateEventDurationMinutes = exports.calculateEventDurationMillis = exports.TimezoneChoiceSorter = exports.DateUtilDecorator = exports.LocaleImpl = exports.PeopleSorter = exports.durationUtil = exports.dateUtil = exports.calendarUtil = void 0;
 var calendar_utility_1 = require("./utilities/calendar.utility");
 Object.defineProperty(exports, "calendarUtil", { enumerable: true, get: function () { return __importDefault(calendar_utility_1).default; } });
 var date_utility_1 = require("./utilities/date.utility");
@@ -53,5 +53,7 @@ var DateParser_1 = require("./parsing/DateParser");
 Object.defineProperty(exports, "DateParser", { enumerable: true, get: function () { return __importDefault(DateParser_1).default; } });
 var sortTimezoneChoices_1 = require("./utilities/sortTimezoneChoices");
 Object.defineProperty(exports, "sortTimezoneChoices", { enumerable: true, get: function () { return __importDefault(sortTimezoneChoices_1).default; } });
+var RepeatingRuleTextGenerator_1 = require("./utilities/RepeatingRuleTextGenerator");
+Object.defineProperty(exports, "RepeatingRuleTextGenerator", { enumerable: true, get: function () { return __importDefault(RepeatingRuleTextGenerator_1).default; } });
 __exportStar(require("./dates"), exports);
 __exportStar(require("./constants"), exports);

package/build/types/calendar.types.d.ts

@@ -14,6 +14,7 @@ export type CalendarEvent = SpruceSchemas.CalendarUtils.v2021_05_19.CalendarEven
 export type DayOfWeek = NonNullable<CalendarEvent['daysOfWeek']>[number];
 export type TimezoneChoices = typeof timezoneChoices;
 export type TimezoneName = TimezoneChoices[number]['value'];
+export type Repeats = NonNullable<CalendarEvent['repeats']>;
 export type Locale = Pick<LocaleImpl, 'on' | 'getZoneName' | 'offsetMinutesToZoneName' | 'getTimezoneOffsetMinutes' | 'setTimezoneOffsetMinutes' | 'setZoneName' | 'zoneNameToOffsetMinutes'>;
 export type SorterCalendarEvent = {
     id: string;

package/build/utilities/RepeatingRuleTextGenerator.d.ts

@@ -0,0 +1,11 @@
+import { CalendarEvent, DateUtil } from '../types/calendar.types';
+export default class RepeatingRuleTextGenerator {
+    private unitMap;
+    private downMap;
+    private dates;
+    private constructor();
+    static Generator(options: {
+        dates: DateUtil;
+    }): RepeatingRuleTextGenerator;
+    generate(event: Pick<CalendarEvent, 'repeats' | 'interval' | 'daysOfWeek' | 'occurrences' | 'repeatsUntil'>): string;
+}

package/build/utilities/RepeatingRuleTextGenerator.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const schema_1 = require("@sprucelabs/schema");
+class RepeatingRuleTextGenerator {
+    constructor(dates) {
+        this.unitMap = {
+            daily: 'days',
+            weekly: 'weeks',
+            monthly: 'months',
+        };
+        this.downMap = {
+            sun: 'Sundays',
+            mon: 'Mondays',
+            tue: 'Tuesdays',
+            wed: 'Wednesdays',
+            thur: 'Thursdays',
+            fri: 'Fridays',
+            sat: 'Saturdays',
+        };
+        this.dates = dates;
+    }
+    static Generator(options) {
+        const { dates } = (0, schema_1.assertOptions)(options, ['dates']);
+        return new this(dates);
+    }
+    generate(event) {
+        const { repeats, repeatsUntil, interval, daysOfWeek, occurrences } = event;
+        let message = '';
+        if (repeats) {
+            if (daysOfWeek) {
+                message = `Repeats weekly on ${daysOfWeek
+                    .map((d) => this.downMap[d])
+                    .join(', ')}`;
+            }
+            else if ((interval !== null && interval !== void 0 ? interval : 0) > 1) {
+                message = `Repeats every ${interval} ${this.unitMap[repeats]}`;
+            }
+            else {
+                message = `Repeats ${repeats}`;
+            }
+            if (occurrences) {
+                message += ` for ${occurrences} times.`;
+            }
+            else if (repeatsUntil) {
+                message += ` until ${this.dates.formatDate(repeatsUntil)}.`;
+            }
+            else {
+                message += ` forever.`;
+            }
+        }
+        return message;
+    }
+}
+exports.default = RepeatingRuleTextGenerator;

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "36.0.29",
+  "version": "36.1.1",
   "files": [
     "build/**/*",
     "!build/__tests__",