Settings change 2.0 (#77)

* chore: add zod * chore: add zod schemas * feat: Switch back to storing data in `data.json` with a sync-watcher * ♻️ chore: strictNullChecks enabled. wow. definitely a chore. * chore: release 1.0.0-a26 Release-As: 1.0.0-a26 * 💡 chore: comment null isNaN behavior * chore: Save audit, added debugs. * chore: Update log message title * chore: Begin re-enabling deleted calendar restoration * feat: Enables restoring deleted calendars + undo/redo history in Calendar creator * fix: can now exit creator again, oops * fix: Fixes drag and drop jumping (close #49) * fix: New month and weekday edit modals in creator * fix: Remove deleted calendars > 7 days old * chore: Remove logs * fix: Can now delete calendars permanently from the Restore modal
javalent · Sep 20, 2023 · 96cd824 · 96cd824
1 parent b2c40bd
commit 96cd824
Show file tree

Hide file tree

Showing 71 changed files with 2,272 additions and 1,193 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# The Calendarium
+# Calendarium
 
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
 [![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -46,7 +46,8 @@
         "tslib": "^2.3.0",
         "typescript": "^4.2.4",
         "vitest": "^0.34.3",
-        "xmldom": "^0.6.0"
+        "xmldom": "^0.6.0",
+        "zod": "^3.22.2"
     },
     "dependencies": {
         "@popperjs/core": "^2.10.2",

diff --git a/src/@types/calendar.d.ts b/src/@types/calendar.d.ts
@@ -39,8 +39,8 @@ export interface StaticCalendarData {
     incrementDay: boolean;
     useCustomYears?: boolean;
     years?: Year[];
-    padMonths?:number;
-    padDays?:number;
+    padMonths?: number;
+    padDays?: number;
 }
 
 export interface CalDate {
@@ -58,15 +58,15 @@ export interface TimeSpan {
 export type BaseDay = TimeSpan & {
     type: "day" | "leapday";
 };
-export type DefinedeDay = {
+export type DefinedBaseDay = {
     number: number;
 };
 export type Day = BaseDay & {
     type: "day";
     abbreviation?: string;
 };
 export type DefinedDay = Day &
-    DefinedDay & {
+    DefinedBaseDay & {
         type: "day";
     };
 export type LeapDay = BaseDay & {
@@ -104,10 +104,10 @@ export interface IntercalaryMonth extends BaseMonth {
 }
 export type Month = RegularMonth | IntercalaryMonth;
 
-interface LeapDayCondition {
-    ignore: boolean; //ignore offset
-    exclusive: boolean; //causes failure if true
-    interval: number; //how many years between checking
+export interface LeapDayCondition {
+    ignore: boolean | null; //ignore offset
+    exclusive: boolean | null; //causes failure if true
+    interval: number | null; //how many years between checking
 }
 
 /**

diff --git a/src/@types/index.d.ts b/src/@types/index.d.ts
@@ -1,41 +1,7 @@
-export * from "./calendar";
-export * from "./event";
-export * from "./moons";
-
-import type { Calendar } from "./calendar";
+export * from "../schemas";
 
 export type Nullable<T> = T | null;
 
-export interface CalendariumData {
-    addToDefaultIfMissing: boolean;
-    calendars: Calendar[];
-    configDirectory: string;
-    dailyNotes: boolean;
-    dateFormat: string;
-    defaultCalendar: string;
-    eventFrontmatter: boolean;
-    eventPreview: boolean;
-    exit: {
-        saving: boolean;
-        event: boolean;
-        calendar: boolean;
-    };
-    parseDates: boolean;
-    settingsToggleState: {
-        calendars: boolean;
-        events: boolean;
-        advanced: boolean;
-    };
-    showIntercalary: boolean;
-    version: {
-        major: number;
-        minor: number;
-        patch: number | string;
-    };
-    debug: boolean;
-    askedToMoveFC: boolean;
-}
-
 export interface CalendariumCodeBlockParameters {
     /** Name of the calendar you wish to display.
      * If omitted, the code block will display the default calendar specified in settings.

diff --git a/src/api/api.ts b/src/api/api.ts
@@ -7,10 +7,11 @@ import { get } from "svelte/store";
 export class API {
     constructor(private plugin: Calendarium) {}
     #getStore(calendar: string | Calendar): CalendarStore {
-        let store: CalendarStore;
+        let store: CalendarStore | null = null;
         if (typeof calendar === "string") {
             store = this.plugin.getStore(
-                this.plugin.data.calendars.find((c) => c.name == calendar).id
+                this.plugin.data.calendars.find((c) => c.name == calendar)
+                    ?.id ?? ""
             );
         } else {
             store = this.plugin.getStoreByCalendar(calendar);
@@ -27,7 +28,9 @@ export class API {
      * @returns An instance of the Calendar API.
      */
     getAPI(calendarName: string): CalendarAPI {
-        const calendar = this.plugin.data.calendars.find((c) => c.name == calendarName);
+        const calendar = this.plugin.data.calendars.find(
+            (c) => c.name == calendarName
+        );
         if (!calendar)
             throw new ReferenceError("No calendar store by that name exists.");
         const store = this.#getStore(calendar);

diff --git a/src/calendar/codeblock.ts b/src/calendar/codeblock.ts
@@ -92,22 +92,22 @@ export class CalendariumEditorSuggester extends EditorSuggest<string> {
         cursor: EditorPosition,
         editor: Editor,
         file: TFile
-    ): EditorSuggestTriggerInfo {
+    ): EditorSuggestTriggerInfo | null {
         const range = editor.getRange({ line: 0, ch: 0 }, cursor);
 
-        if (range.indexOf("```calendarium\n") === -1) return;
+        if (range.indexOf("```calendarium\n") === -1) return null;
 
         const split = range.split("\n").reverse();
 
         let inBlock = false;
         for (const line of split) {
-            if (/^```$/.test(line)) return;
+            if (/^```$/.test(line)) return null;
             if (/^```calendarium/.test(line)) {
                 inBlock = true;
                 break;
             }
         }
-        if (!inBlock) return;
+        if (!inBlock) return null;
 
         const line = editor.getLine(cursor.line);
         //not inside the bracket

diff --git a/src/calendar/event-modal.ts b/src/calendar/event-modal.ts
@@ -13,9 +13,9 @@ export class ViewEventModal extends CalendariumModal {
         this.contentEl.createEl("h4", { text: this.event.name });
 
         await MarkdownRenderer.renderMarkdown(
-            this.event.description,
+            this.event.description ?? "",
             this.contentEl,
-            this.event.note,
+            this.event.note ?? "",
             new Component()
         );
     }

diff --git a/src/calendar/ui/Calendar.svelte b/src/calendar/ui/Calendar.svelte
@@ -46,6 +46,10 @@
             menu.addItem((item) =>
                 item.setTitle(calendar.name).onClick(() => {
                     const newStore = plugin.getStore(calendar.id);
+                    if (!newStore)
+                        throw new Error(
+                            "Could not find a calendar by that name"
+                        );
                     global.set(newStore);
                     ephemeral.set(newStore.ephemeralStore);
                     if (view) {
@@ -59,11 +63,11 @@
         menu.showAtMouseEvent(evt);
     };
     $: weekForDay = $daysAsWeeks.find((w) =>
-        w.find((day) => day.number == $displaying.day)
-    );
+        w.find((day) => day && day.number == $displaying.day)
+    ) ?? [];
     $: weekNumber =
         $daysAsWeeks.findIndex((w) =>
-            w.find((day) => day.number == $displaying.day)
+            w.find((day) => day && day.number == $displaying.day)
         ) +
         $firstWeekNumber +
         1;

diff --git a/src/calendar/ui/Day/DayView.svelte b/src/calendar/ui/Day/DayView.svelte
@@ -12,15 +12,15 @@
     $: store = $global;
     $: viewing = $ephemeral.viewing;
     $: if (!$viewing) viewing = $ephemeral.displaying;
-    $: date = dateString($viewing, $store);
+    $: date = dateString($viewing!, $store);
     $: yearCalculator = store.yearCalculator;
     $: displayedMonth = yearCalculator
-        .getYearFromCache($viewing.year)
-        .getMonthFromCache($viewing.month);
+        .getYearFromCache($viewing!.year)
+        .getMonthFromCache($viewing!.month);
     $: daysBeforeMonth = displayedMonth.daysBefore;
-    $: daysBeforeDay = $daysBeforeMonth + $viewing.day;
-    $: events = store.eventStore.getEventsForDate($viewing);
-    $: moons = store.moonCache.getItemsOrRecalculate($viewing);
+    $: daysBeforeDay = $daysBeforeMonth + $viewing!.day;
+    $: events = store.eventStore.getEventsForDate($viewing!);
+    $: moons = store.moonCache.getItemsOrRecalculate($viewing!);
     $: displayDayNumber = $ephemeral.displayDayNumber;
     $: displayMoons = $ephemeral.displayMoons;
 
@@ -52,6 +52,9 @@
             <div
                 use:reveal
                 on:click={() => {
+                    if (!$viewing) {
+                        viewing = $ephemeral.displaying;
+                    }
                     $ephemeral.displayDate($viewing);
                 }}
             />
@@ -98,14 +101,16 @@
         </div>
     {/if}
     {#key $events}
-        <Flags
-            events={$events}
-            dayView={true}
-            date={$viewing}
-            on:event-click
-            on:event-mouseover
-            on:event-context
-        />
+        {#if $viewing}
+            <Flags
+                events={$events}
+                dayView={true}
+                date={$viewing}
+                on:event-click
+                on:event-mouseover
+                on:event-context
+            />
+        {/if}
     {/key}
 </div>
 

diff --git a/src/calendar/ui/Events/Dot.svelte b/src/calendar/ui/Events/Dot.svelte
@@ -1,7 +1,7 @@
 <script lang="ts">
     export let isFilled: boolean = true;
     export let isActive: boolean = false;
-    export let color: string;
+    export let color: string | undefined;
 </script>
 
 <svg

diff --git a/src/calendar/ui/Events/Flag.svelte b/src/calendar/ui/Events/Flag.svelte
@@ -78,7 +78,7 @@
         }
     };
 
-    export let flag: HTMLElement = null;
+    export let flag: HTMLElement | null = null;
 
     const contextMenu = (evt: MouseEvent) => {
         evt.stopPropagation();

diff --git a/src/calendar/ui/Events/Flags.svelte b/src/calendar/ui/Events/Flags.svelte
@@ -50,7 +50,7 @@
                             0
                         );
                     if (remaining < 0 && height != 0) {
-                        target.lastElementChild.detach();
+                        target.lastElementChild?.detach();
                         overflow = events.length - events.indexOf(event);
                         break;
                     } else if (remaining == 0) {

diff --git a/src/calendar/ui/Moon.svelte b/src/calendar/ui/Moon.svelte
@@ -6,7 +6,7 @@
     export let label: boolean = true;
     export let size = 28;
 
-    $: path = SHADOW_MAP[moon.phase];
+    $: path = SHADOW_MAP[moon.phase ?? "New Moon"];
 </script>
 
 <svg

diff --git a/src/calendar/ui/Nav.svelte b/src/calendar/ui/Nav.svelte
@@ -105,7 +105,7 @@
                 />
                 <div
                     class="reset-button calendar-clickable"
-                    on:click={() => $ephemeral.displayDate()}
+                    on:click={() => $ephemeral.displayDate(null)}
                     aria-label="Today is {$currentDisplay}"
                 >
                     <span>Today</span>