@calends/vue 0.0.0-stage → 0.1.0

package/dist/useInteractions.d.ts

@@ -0,0 +1,112 @@
+import { type ComputedRef, type MaybeRefOrGetter } from 'vue';
+import { type CalendarEvent, type CalendarEventInput, type CalendarResource, type EventDelta, type EventTimes, type ResourceId } from '@calends/core';
+/** What sits under the pointer: a day cell, a point in a day's hours, or a point on a timeline. */
+export interface DropTarget {
+    kind: 'day' | 'time' | 'axis' | 'dayaxis';
+    date: Temporal.PlainDate;
+    /** Wall-clock minutes from midnight, for `time` and `axis` targets. */
+    minutes: number | null;
+    /** Present only on targets inside a resource row; null for the unassigned row. */
+    resourceId?: ResourceId | null;
+}
+export interface EventDropDetail<T extends CalendarEventInput = CalendarEventInput> {
+    event: T;
+    start: Temporal.PlainDate | Temporal.ZonedDateTime;
+    end: Temporal.PlainDate | Temporal.ZonedDateTime;
+    previousStart: Temporal.PlainDate | Temporal.ZonedDateTime;
+    previousEnd: Temporal.PlainDate | Temporal.ZonedDateTime;
+    allDay: boolean;
+    /** Set only when the event moved to another resource row (null for unassigned). */
+    resourceId?: ResourceId | null;
+    previousResourceId?: ResourceId | null;
+}
+export interface RangeSelectDetail {
+    start: Temporal.PlainDate | Temporal.ZonedDateTime;
+    /** Inclusive last day for all-day ranges, exclusive end time for timed ones. */
+    end: Temporal.PlainDate | Temporal.ZonedDateTime;
+    allDay: boolean;
+    resourceId?: ResourceId | null;
+}
+/** How arrow keys move a picked-up event in each layout. */
+export interface KeyboardAxes {
+    horizontal: 'day' | 'minutes';
+    vertical: 'week' | 'minutes' | 'resource' | 'none';
+    /** Resource ids in row order, for `vertical: 'resource'`. */
+    resourceOrder?: readonly (ResourceId | null)[];
+}
+export interface InteractionOptions<T extends CalendarEventInput> {
+    events: ComputedRef<CalendarEvent<T>[]>;
+    resources: MaybeRefOrGetter<readonly CalendarResource[] | undefined>;
+    getResourceIds?: (event: T) => readonly ResourceId[] | null | undefined;
+    timeZone: ComputedRef<string>;
+    locale: ComputedRef<string | undefined>;
+    rangeStart: ComputedRef<Temporal.PlainDate>;
+    slotMinMinutes: MaybeRefOrGetter<number | undefined>;
+    slotMaxMinutes: MaybeRefOrGetter<number | undefined>;
+    editable?: MaybeRefOrGetter<boolean | undefined>;
+    selectable?: MaybeRefOrGetter<boolean | undefined>;
+    snapMinutes?: MaybeRefOrGetter<number | undefined>;
+    canEdit?: (event: T) => boolean;
+    onEventDrop?: (detail: EventDropDetail<T>) => void;
+    onEventResize?: (detail: EventDropDetail<T>) => void;
+    onRangeSelect?: (detail: RangeSelectDetail) => void;
+}
+type DragKind = 'move' | 'resize-start' | 'resize-end';
+export interface DragState<T extends CalendarEventInput> {
+    kind: DragKind;
+    event: CalendarEvent<T>;
+    origin: DropTarget;
+    started: boolean;
+    keyboard: boolean;
+    pointer: {
+        x: number;
+        y: number;
+    };
+    preview: EventTimes;
+    resourceId: ResourceId | null | undefined;
+    /** Keyboard only: accumulated movement, and a separate end-edge resize from Shift. */
+    moveDelta: EventDelta;
+    endDelta: EventDelta;
+    axes?: KeyboardAxes;
+}
+export declare function useInteractions<T extends CalendarEventInput>(options: InteractionOptions<T>): {
+    editable: ComputedRef<boolean>;
+    selectable: ComputedRef<boolean>;
+    drag: import("vue").ShallowRef<DragState<T> | null, DragState<T> | null>;
+    selectedRange: ComputedRef<{
+        kind: "day" | "dayaxis";
+        resourceId: ResourceId | null | undefined;
+        startDate: Temporal.PlainDate;
+        endDate: Temporal.PlainDate;
+        detail: {
+            start: Temporal.PlainDate;
+            end: Temporal.PlainDate;
+            allDay: boolean;
+            resourceId: ResourceId | null | undefined;
+        };
+        startMinutes?: undefined;
+        endMinutes?: undefined;
+    } | {
+        kind: "time" | "axis";
+        resourceId: ResourceId | null | undefined;
+        startDate: Temporal.PlainDate;
+        endDate: Temporal.PlainDate;
+        startMinutes: number;
+        endMinutes: number;
+        detail: {
+            start: Temporal.ZonedDateTime;
+            end: Temporal.ZonedDateTime;
+            allDay: boolean;
+            resourceId: ResourceId | null | undefined;
+        };
+    } | null>;
+    announcement: import("vue").Ref<string, string>;
+    displayEvents: ComputedRef<CalendarEvent<T>[]>;
+    displayResourceIds: (event: T) => readonly ResourceId[] | null | undefined;
+    canEdit: (event: CalendarEvent<T>) => boolean;
+    isDragging: (event: CalendarEvent<T>) => boolean;
+    startPointerDrag: (pointerEvent: PointerEvent, event: CalendarEvent<T>, kind: DragKind) => void;
+    startSelection: (pointerEvent: PointerEvent) => void;
+    handleEventKeydown: (keyboardEvent: KeyboardEvent, event: CalendarEvent<T>, axes: KeyboardAxes, resourceId?: ResourceId | null) => void;
+};
+export {};

package/package.json

@@ -1,6 +1,54 @@
 {
   "name": "@calends/vue",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.0",
+  "description": "Headless Vue calendar primitives, styled with data attributes. Ships no CSS.",
+  "keywords": [
+    "vue",
+    "calendar",
+    "headless",
+    "temporal",
+    "scheduler",
+    "gantt",
+    "timeline",
+    "reka-ui"
+  ],
+  "license": "MIT",
+  "author": "Ben Miller",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/benjivm/calends.git",
+    "directory": "packages/vue"
+  },
+  "homepage": "https://github.com/benjivm/calends#readme",
+  "bugs": "https://github.com/benjivm/calends/issues",
+  "type": "module",
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "@calends/core": "^0.1.0"
+  },
+  "peerDependencies": {
+    "reka-ui": "^2.11.0",
+    "vue": "^3.5.0"
+  },
+  "devDependencies": {
+    "reka-ui": "^2.11.0",
+    "vue": "~3.5.44"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "vite build && vue-tsc -p tsconfig.build.json && node scripts/fix-declarations.mjs",
+    "typecheck": "vue-tsc -p tsconfig.json --noEmit"
+  }
 }