@tasknotes/calendar 0.0.0-stage → 0.1.1

package/dist/types/dom/views/timeline.d.cts

@@ -0,0 +1,83 @@
+import { type Day } from "../../core/date.cjs";
+import type { StoreChange } from "../../core/store.cjs";
+import { type Selection, type View, type ViewContext } from "../context.cjs";
+import { type Hit } from "../options.cjs";
+/**
+ * Gantt-style timeline: one row per `TimelineRow`, bars positioned on civil
+ * days so DST never stretches a day.
+ */
+export declare class TimelineView<D> implements View {
+    private readonly ctx;
+    readonly el: HTMLElement;
+    private readonly scroller;
+    private readonly canvas;
+    private readonly head;
+    private readonly ticks;
+    private readonly rowsEl;
+    private readonly svg;
+    private readonly todayLine;
+    private readonly todayTag;
+    private readonly selLayer;
+    private rows;
+    private readonly scale;
+    private readonly dayWidth;
+    private readonly startDay;
+    private readonly endDay;
+    private readonly labelWidth;
+    private readonly rowHeight;
+    private link;
+    private get tl();
+    constructor(ctx: ViewContext<D>);
+    private trackWidth;
+    /** X offset (within the track) of an instant. */
+    private x;
+    private xDay;
+    /** Instant at a track x offset. */
+    private msAt;
+    /** Viewport x (from the scroller's left edge) where the track starts showing, and its visible width. */
+    private trackViewport;
+    /** Instant under a viewport x, measured from the scroller's left edge. */
+    instantAt(viewportX: number): number;
+    /** Viewport x of an instant at the current scroll. */
+    viewportXOf(ms: number): number;
+    /** Scrolls so `ms` sits at `viewportX`. */
+    placeInstant(ms: number, viewportX: number, smooth?: boolean): void;
+    scrollToInstant(ms: number, align: "start" | "center" | "end", smooth: boolean): void;
+    /** Viewport x of the middle of the visible track. */
+    viewportCentre(): number;
+    /** The scroller's left edge in client coordinates. */
+    viewportLeft(): number;
+    private scrollLeftTo;
+    private buildHead;
+    private mountRow;
+    private unmountRow;
+    render(_change: StoreChange | null): void;
+    private placeBar;
+    private rowOfItem;
+    /** Track x of a bar's start or finish edge. */
+    private edgeX;
+    private drawDependencies;
+    private linkTargetAt;
+    /** Centre of a target edge's port, in track coordinates. */
+    private targetPoint;
+    private linkArg;
+    private linkState;
+    private markTarget;
+    private readonly onLinkDown;
+    private endLink;
+    showSelection(sel: Selection | null): void;
+    hit(x: number, y: number): Hit | null;
+    tick(): void;
+    /** Scrolls so `day` sits a little in from the left edge. */
+    scrollToDay(day: Day): void;
+    getScroll(): {
+        top: number;
+        left: number;
+    };
+    setScroll(s: {
+        top: number;
+        left: number;
+    }): void;
+    elementsFor(id: string): HTMLElement[];
+    destroy(): void;
+}

package/dist/types/dom/views/timeline.d.ts

@@ -0,0 +1,83 @@
+import { type Day } from "../../core/date.js";
+import type { StoreChange } from "../../core/store.js";
+import { type Selection, type View, type ViewContext } from "../context.js";
+import { type Hit } from "../options.js";
+/**
+ * Gantt-style timeline: one row per `TimelineRow`, bars positioned on civil
+ * days so DST never stretches a day.
+ */
+export declare class TimelineView<D> implements View {
+    private readonly ctx;
+    readonly el: HTMLElement;
+    private readonly scroller;
+    private readonly canvas;
+    private readonly head;
+    private readonly ticks;
+    private readonly rowsEl;
+    private readonly svg;
+    private readonly todayLine;
+    private readonly todayTag;
+    private readonly selLayer;
+    private rows;
+    private readonly scale;
+    private readonly dayWidth;
+    private readonly startDay;
+    private readonly endDay;
+    private readonly labelWidth;
+    private readonly rowHeight;
+    private link;
+    private get tl();
+    constructor(ctx: ViewContext<D>);
+    private trackWidth;
+    /** X offset (within the track) of an instant. */
+    private x;
+    private xDay;
+    /** Instant at a track x offset. */
+    private msAt;
+    /** Viewport x (from the scroller's left edge) where the track starts showing, and its visible width. */
+    private trackViewport;
+    /** Instant under a viewport x, measured from the scroller's left edge. */
+    instantAt(viewportX: number): number;
+    /** Viewport x of an instant at the current scroll. */
+    viewportXOf(ms: number): number;
+    /** Scrolls so `ms` sits at `viewportX`. */
+    placeInstant(ms: number, viewportX: number, smooth?: boolean): void;
+    scrollToInstant(ms: number, align: "start" | "center" | "end", smooth: boolean): void;
+    /** Viewport x of the middle of the visible track. */
+    viewportCentre(): number;
+    /** The scroller's left edge in client coordinates. */
+    viewportLeft(): number;
+    private scrollLeftTo;
+    private buildHead;
+    private mountRow;
+    private unmountRow;
+    render(_change: StoreChange | null): void;
+    private placeBar;
+    private rowOfItem;
+    /** Track x of a bar's start or finish edge. */
+    private edgeX;
+    private drawDependencies;
+    private linkTargetAt;
+    /** Centre of a target edge's port, in track coordinates. */
+    private targetPoint;
+    private linkArg;
+    private linkState;
+    private markTarget;
+    private readonly onLinkDown;
+    private endLink;
+    showSelection(sel: Selection | null): void;
+    hit(x: number, y: number): Hit | null;
+    tick(): void;
+    /** Scrolls so `day` sits a little in from the left edge. */
+    scrollToDay(day: Day): void;
+    getScroll(): {
+        top: number;
+        left: number;
+    };
+    setScroll(s: {
+        top: number;
+        left: number;
+    }): void;
+    elementsFor(id: string): HTMLElement[];
+    destroy(): void;
+}

package/dist/types/dom/views/year.d.cts

@@ -0,0 +1,26 @@
+import { type Day } from "../../core/date.cjs";
+import type { StoreChange } from "../../core/store.cjs";
+import type { Selection, View, ViewContext } from "../context.cjs";
+import type { Hit } from "../options.cjs";
+/** Twelve compact months. Each day shows how busy it is; clicking opens it. */
+export declare class YearView<D> implements View {
+    private readonly ctx;
+    readonly el: HTMLElement;
+    private readonly scroller;
+    private cells;
+    constructor(ctx: ViewContext<D>);
+    render(_change: StoreChange | null): void;
+    showSelection(_sel: Selection | null): void;
+    hit(x: number, y: number): Hit | null;
+    dayAt(el: Element): Day | null;
+    getScroll(): {
+        top: number;
+        left: number;
+    };
+    setScroll(s: {
+        top: number;
+        left: number;
+    }): void;
+    elementsFor(_id: string): HTMLElement[];
+    destroy(): void;
+}

package/dist/types/dom/views/year.d.ts

@@ -0,0 +1,26 @@
+import { type Day } from "../../core/date.js";
+import type { StoreChange } from "../../core/store.js";
+import type { Selection, View, ViewContext } from "../context.js";
+import type { Hit } from "../options.js";
+/** Twelve compact months. Each day shows how busy it is; clicking opens it. */
+export declare class YearView<D> implements View {
+    private readonly ctx;
+    readonly el: HTMLElement;
+    private readonly scroller;
+    private cells;
+    constructor(ctx: ViewContext<D>);
+    render(_change: StoreChange | null): void;
+    showSelection(_sel: Selection | null): void;
+    hit(x: number, y: number): Hit | null;
+    dayAt(el: Element): Day | null;
+    getScroll(): {
+        top: number;
+        left: number;
+    };
+    setScroll(s: {
+        top: number;
+        left: number;
+    }): void;
+    elementsFor(_id: string): HTMLElement[];
+    destroy(): void;
+}

package/dist/types/index.d.cts

@@ -0,0 +1,6 @@
+export * from "./core/index.cjs";
+export { Calendar } from "./dom/calendar.cjs";
+export type { ElMeta, Selection, Variant } from "./dom/context.cjs";
+export { Formatter, localeFirstDay } from "./dom/format.cjs";
+export * from "./dom/options.cjs";
+export * from "./tasknotes/bases.cjs";

package/dist/types/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./core/index.js";
+export { Calendar } from "./dom/calendar.js";
+export type { ElMeta, Selection, Variant } from "./dom/context.js";
+export { Formatter, localeFirstDay } from "./dom/format.js";
+export * from "./dom/options.js";
+export * from "./tasknotes/bases.js";

package/dist/types/react/index.d.cts

@@ -0,0 +1,20 @@
+import { type CSSProperties } from "react";
+import type { CalendarItem } from "../core/types.cjs";
+import { Calendar } from "../dom/calendar.cjs";
+import type { CalendarOptions } from "../dom/options.cjs";
+export interface TaskCalendarProps<D> extends Partial<CalendarOptions<D>> {
+    items: readonly CalendarItem<D>[];
+    className?: string;
+    style?: CSSProperties;
+    /** Receives the Calendar instance (null on unmount). */
+    calendarRef?: (calendar: Calendar<D> | null) => void;
+    /** Change to force a full re-render, e.g. when render hooks read new state. */
+    renderKey?: unknown;
+}
+/**
+ * React binding. Options are diffed by value, so inline callbacks and object
+ * literals do not cause rebuilds; callbacks always see the latest props.
+ */
+export declare function TaskCalendar<D = unknown>(props: TaskCalendarProps<D>): import("react").JSX.Element;
+export { Calendar };
+export type { CalendarItem, CalendarOptions };

package/dist/types/react/index.d.ts

@@ -0,0 +1,20 @@
+import { type CSSProperties } from "react";
+import type { CalendarItem } from "../core/types.js";
+import { Calendar } from "../dom/calendar.js";
+import type { CalendarOptions } from "../dom/options.js";
+export interface TaskCalendarProps<D> extends Partial<CalendarOptions<D>> {
+    items: readonly CalendarItem<D>[];
+    className?: string;
+    style?: CSSProperties;
+    /** Receives the Calendar instance (null on unmount). */
+    calendarRef?: (calendar: Calendar<D> | null) => void;
+    /** Change to force a full re-render, e.g. when render hooks read new state. */
+    renderKey?: unknown;
+}
+/**
+ * React binding. Options are diffed by value, so inline callbacks and object
+ * literals do not cause rebuilds; callbacks always see the latest props.
+ */
+export declare function TaskCalendar<D = unknown>(props: TaskCalendarProps<D>): import("react").JSX.Element;
+export { Calendar };
+export type { CalendarItem, CalendarOptions };

package/dist/types/tasknotes/bases.d.cts

@@ -0,0 +1,50 @@
+import type { CalendarOptions, ViewType } from "../dom/options.cjs";
+/** View names stored in `.base` files (FullCalendar's names, kept for compatibility). */
+export type BasesCalendarViewName = "dayGridMonth" | "timeGridWeek" | "timeGridCustom" | "timeGridDay" | "listWeek" | "multiMonthYear";
+export declare function viewFromBases(name: string | null | undefined, fallback?: ViewType): ViewType;
+export declare function viewToBases(view: ViewType): BasesCalendarViewName | null;
+/**
+ * Layout settings of the TaskNotes calendar Bases view, as stored in `.base`
+ * files (event toggles and data settings are not layout and are not here).
+ */
+export interface BasesCalendarLayout {
+    calendarView?: string | null;
+    customDayCount?: number | null;
+    listDayCount?: number | null;
+    heightMode?: string | null;
+    firstDay?: string | number | null;
+    timeFormat?: string | null;
+    weekNumbers?: boolean | null;
+    showWeekends?: boolean | null;
+    showAllDaySlot?: boolean | null;
+    showTodayHighlight?: boolean | null;
+    todayColumnWidthMultiplier?: number | null;
+    slotMinTime?: string | null;
+    slotMaxTime?: string | null;
+    slotDuration?: string | null;
+    snapDuration?: string | null;
+    scrollTime?: string | null;
+    nowIndicator?: boolean | null;
+    showTimeGrid?: boolean | null;
+    selectMirror?: boolean | null;
+    slotEventOverlap?: boolean | null;
+    eventMinHeight?: number | null;
+    eventMaxStack?: number | null;
+    dayMaxEvents?: number | boolean | null;
+    dayMaxEventRows?: number | boolean | null;
+    locale?: string | null;
+}
+/** Defaults used by TaskNotes when a key is absent. */
+export declare const BASES_CALENDAR_DEFAULTS: Required<{
+    [K in keyof BasesCalendarLayout]: NonNullable<BasesCalendarLayout[K]>;
+}>;
+/** "HH:MM[:SS]" check with the same limits TaskNotes enforces. */
+export declare function isValidSlotTime(value: string, maxHours?: number): boolean;
+/**
+ * Converts Bases calendar settings to calendar options, applying the same
+ * normalisation the FullCalendar-based view did, so existing `.base` files
+ * keep their behaviour.
+ */
+export declare function basesLayoutOptions<D>(s: BasesCalendarLayout, context?: {
+    embedded?: boolean;
+}): Partial<CalendarOptions<D>>;

package/dist/types/tasknotes/bases.d.ts

@@ -0,0 +1,50 @@
+import type { CalendarOptions, ViewType } from "../dom/options.js";
+/** View names stored in `.base` files (FullCalendar's names, kept for compatibility). */
+export type BasesCalendarViewName = "dayGridMonth" | "timeGridWeek" | "timeGridCustom" | "timeGridDay" | "listWeek" | "multiMonthYear";
+export declare function viewFromBases(name: string | null | undefined, fallback?: ViewType): ViewType;
+export declare function viewToBases(view: ViewType): BasesCalendarViewName | null;
+/**
+ * Layout settings of the TaskNotes calendar Bases view, as stored in `.base`
+ * files (event toggles and data settings are not layout and are not here).
+ */
+export interface BasesCalendarLayout {
+    calendarView?: string | null;
+    customDayCount?: number | null;
+    listDayCount?: number | null;
+    heightMode?: string | null;
+    firstDay?: string | number | null;
+    timeFormat?: string | null;
+    weekNumbers?: boolean | null;
+    showWeekends?: boolean | null;
+    showAllDaySlot?: boolean | null;
+    showTodayHighlight?: boolean | null;
+    todayColumnWidthMultiplier?: number | null;
+    slotMinTime?: string | null;
+    slotMaxTime?: string | null;
+    slotDuration?: string | null;
+    snapDuration?: string | null;
+    scrollTime?: string | null;
+    nowIndicator?: boolean | null;
+    showTimeGrid?: boolean | null;
+    selectMirror?: boolean | null;
+    slotEventOverlap?: boolean | null;
+    eventMinHeight?: number | null;
+    eventMaxStack?: number | null;
+    dayMaxEvents?: number | boolean | null;
+    dayMaxEventRows?: number | boolean | null;
+    locale?: string | null;
+}
+/** Defaults used by TaskNotes when a key is absent. */
+export declare const BASES_CALENDAR_DEFAULTS: Required<{
+    [K in keyof BasesCalendarLayout]: NonNullable<BasesCalendarLayout[K]>;
+}>;
+/** "HH:MM[:SS]" check with the same limits TaskNotes enforces. */
+export declare function isValidSlotTime(value: string, maxHours?: number): boolean;
+/**
+ * Converts Bases calendar settings to calendar options, applying the same
+ * normalisation the FullCalendar-based view did, so existing `.base` files
+ * keep their behaviour.
+ */
+export declare function basesLayoutOptions<D>(s: BasesCalendarLayout, context?: {
+    embedded?: boolean;
+}): Partial<CalendarOptions<D>>;

package/package.json

@@ -1,6 +1,109 @@
 {
-  "name": "@tasknotes/calendar",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+	"name": "@tasknotes/calendar",
+	"version": "0.1.1",
+	"description": "Task-native calendar engine for TaskNotes: incremental layout, time grid, month, list, year and timeline views.",
+	"license": "MIT",
+	"type": "module",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/callumalpass/tasknotes-calendar.git"
+	},
+	"keywords": [
+		"calendar",
+		"tasknotes",
+		"timeline",
+		"scheduling",
+		"typescript",
+		"obsidian"
+	],
+	"bugs": {
+		"url": "https://github.com/callumalpass/tasknotes-calendar/issues"
+	},
+	"homepage": "https://github.com/callumalpass/tasknotes-calendar#readme",
+	"engines": {
+		"node": ">=22"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.js",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"import": {
+				"types": "./dist/types/index.d.ts",
+				"default": "./dist/esm/index.js"
+			},
+			"require": {
+				"types": "./dist/types/index.d.cts",
+				"default": "./dist/cjs/index.cjs"
+			}
+		},
+		"./core": {
+			"import": {
+				"types": "./dist/types/core/index.d.ts",
+				"default": "./dist/esm/core.js"
+			},
+			"require": {
+				"types": "./dist/types/core/index.d.cts",
+				"default": "./dist/cjs/core.cjs"
+			}
+		},
+		"./react": {
+			"import": {
+				"types": "./dist/types/react/index.d.ts",
+				"default": "./dist/esm/react.js"
+			},
+			"require": {
+				"types": "./dist/types/react/index.d.cts",
+				"default": "./dist/cjs/react.cjs"
+			}
+		},
+		"./calendar.css": "./dist/calendar.css"
+	},
+	"files": [
+		"dist",
+		"README.md",
+		"CHANGELOG.md",
+		"LICENSE"
+	],
+	"sideEffects": [
+		"*.css"
+	],
+	"peerDependencies": {
+		"react": ">=18"
+	},
+	"peerDependenciesMeta": {
+		"react": {
+			"optional": true
+		}
+	},
+	"scripts": {
+		"clean": "node -e \"require('fs').rmSync('dist', { recursive: true, force: true })\"",
+		"build": "npm run clean && node scripts/build.mjs && tsc -p tsconfig.types.json && node scripts/declarations.mjs",
+		"typecheck": "tsc -p tsconfig.json --noEmit",
+		"lint": "eslint src test",
+		"test": "vitest run",
+		"test:watch": "vitest",
+		"test:browser": "playwright test",
+		"test:package": "node scripts/smoke-package.mjs",
+		"playground": "node scripts/playground.mjs",
+		"prepack": "npm run build"
+	},
+	"devDependencies": {
+		"@axe-core/playwright": "4.14.0",
+		"@playwright/test": "1.64.1",
+		"@types/react": "^19.3.0",
+		"@types/react-dom": "^19.3.0",
+		"esbuild": "^0.28.2",
+		"eslint": "^9.39.5",
+		"happy-dom": "^21.0.4",
+		"react": "^19.3.1",
+		"react-dom": "^19.3.1",
+		"typescript": "^5.9.3",
+		"typescript-eslint": "^8.72.0",
+		"vite": "^8.3.5",
+		"vitest": "^5.0.5"
+	}
+}