@lavalogic/scoria 0.40.21 → 0.40.24

package/dist/Components/ResourceCalendar/ResourceCalendar.svelte.d.ts

@@ -0,0 +1,25 @@
+import type { CalendarEvent, ResourceCalendarProps } from './ResourceCalendarProps.js';
+declare function $$render<E extends CalendarEvent>(): {
+    props: ResourceCalendarProps<E>;
+    exports: {};
+    bindings: "";
+    slots: {};
+    events: {};
+};
+declare class __sveltets_Render<E extends CalendarEvent> {
+    props(): ReturnType<typeof $$render<E>>['props'];
+    events(): ReturnType<typeof $$render<E>>['events'];
+    slots(): ReturnType<typeof $$render<E>>['slots'];
+    bindings(): "";
+    exports(): {};
+}
+interface $$IsomorphicComponent {
+    new <E extends CalendarEvent>(options: import('svelte').ComponentConstructorOptions<ReturnType<__sveltets_Render<E>['props']>>): import('svelte').SvelteComponent<ReturnType<__sveltets_Render<E>['props']>, ReturnType<__sveltets_Render<E>['events']>, ReturnType<__sveltets_Render<E>['slots']>> & {
+        $$bindings?: ReturnType<__sveltets_Render<E>['bindings']>;
+    } & ReturnType<__sveltets_Render<E>['exports']>;
+    <E extends CalendarEvent>(internal: unknown, props: ReturnType<__sveltets_Render<E>['props']> & {}): ReturnType<__sveltets_Render<E>['exports']>;
+    z_$$bindings?: ReturnType<__sveltets_Render<any>['bindings']>;
+}
+declare const ResourceCalendar: $$IsomorphicComponent;
+type ResourceCalendar<E extends CalendarEvent> = InstanceType<typeof ResourceCalendar<E>>;
+export default ResourceCalendar;

package/dist/Components/ResourceCalendar/ResourceCalendarProps.d.ts

@@ -0,0 +1,116 @@
+import type { InputDateWithTime } from '../../Types/Internal/Misc.js';
+import type { SvelteDate } from 'svelte/reactivity';
+import type { Snippet } from 'svelte';
+/**
+ * Available calendar view modes.
+ *
+ * Frozen const + derived type, following the scoria enum-as-const convention.
+ */
+export declare const CalendarViewMode: {
+    readonly Day: "day";
+    readonly Week: "week";
+    readonly Month: "month";
+};
+export type CalendarViewMode = (typeof CalendarViewMode)[keyof typeof CalendarViewMode];
+/**
+ * A column the calendar lays events out under — a generic "lane" such as a
+ * room, a machine, a person, or (in the appointments app) a door.
+ */
+export interface CalendarResource {
+    readonly id: number;
+    readonly label: string;
+}
+/**
+ * The minimum data a calendar event must supply: an id, the resource (column)
+ * it belongs to, and its start/end. Consumers extend this interface with their
+ * own domain fields and render the card body + colours via the `event` snippet
+ * — the component itself is domain-agnostic.
+ *
+ * `start` and `end` are branded with {@link InputDateWithTime} so callers
+ * cannot pass a raw `string` that does not parse as an ISO date-time. The
+ * branded values remain plain strings at runtime; the component parses them
+ * into `Date` internally.
+ */
+export interface CalendarEvent {
+    readonly id: number;
+    readonly resourceId: number;
+    readonly start: InputDateWithTime;
+    readonly end: InputDateWithTime;
+}
+/**
+ * A span of available time on the currently displayed day, expressed in minutes
+ * from midnight (`startMinutes` inclusive, `endMinutes` exclusive). Consumed by
+ * {@link ResourceCalendarProps.availability} to shade out times a resource is
+ * not bookable.
+ */
+export interface CalendarAvailabilityWindow {
+    readonly startMinutes: number;
+    readonly endMinutes: number;
+}
+/** Emitted when the user click-drags a new time range within a resource column. */
+export interface CalendarRangeSelection {
+    readonly resourceId: number;
+    readonly start: Date;
+    readonly end: Date;
+}
+/** Emitted when the user drags an existing event to a new resource and/or time. */
+export interface CalendarEventMoveArgs<E extends CalendarEvent> {
+    readonly event: E;
+    readonly newResourceId: number;
+    readonly newStart: Date;
+    readonly newEnd: Date;
+}
+export interface ResourceCalendarProps<E extends CalendarEvent> {
+    /** The columns to display (e.g. doors, rooms, machines). */
+    resources: ReadonlyArray<CalendarResource>;
+    /** The events to render. */
+    events: ReadonlyArray<E>;
+    /**
+     * Renders one event's card body and colours. The component only provides
+     * the positioned, interactive wrapper (drag/click) around it, so the
+     * consumer owns all domain-specific appearance. The snippet should render a
+     * full-size card (e.g. `height: 100%`).
+     */
+    event: Snippet<[E]>;
+    /**
+     * The currently selected date. Accepts a `Date` or a `SvelteDate`; the
+     * component never writes to it — use `ondatechange`.
+     */
+    selectedDate: Date | SvelteDate;
+    /** The current view mode. */
+    viewMode: CalendarViewMode;
+    /** Called when the user changes the selected date. */
+    ondatechange: (date: Date) => void;
+    /** Called when the user changes the view mode. */
+    onviewmodechange: (mode: CalendarViewMode) => void;
+    /** Called when the user click-drags to select a new time range in a column. */
+    onrangeselect?: (selection: CalendarRangeSelection) => void;
+    /** Called when the user clicks an event. */
+    oneventclick?: (event: E) => void;
+    /** Called when the user drags an event to a new resource and/or time slot. */
+    oneventmove?: (args: CalendarEventMoveArgs<E>) => void;
+    /** The start hour for the day/week grid (default: 0). */
+    startHour?: number;
+    /** The end hour for the day/week grid (default: 24). */
+    endHour?: number;
+    /** The slot interval in minutes (default: 15). */
+    slotIntervalMinutes?: number;
+    /**
+     * Per-resource availability for the displayed day, keyed by resource id.
+     *
+     * Any slot whose start falls outside all of a resource's windows is shaded
+     * unavailable and cannot seed/receive an event. A resource absent from the
+     * map is fully available (no shading); map an id to an empty array to mark
+     * it wholly unavailable. Omit the prop to disable shading.
+     */
+    availability?: ReadonlyMap<number, ReadonlyArray<CalendarAvailabilityWindow>>;
+    /**
+     * Hour of the day (0–23) to vertically centre when the day/week grid first
+     * appears (default: 12). Set to `null` to keep the grid scrolled to the top.
+     */
+    centreHour?: number | null;
+    /** Whether the calendar is loading data. */
+    isLoading?: boolean;
+    /** Optional snippet for extra header content (e.g. buttons). */
+    headerExtra?: Snippet;
+}

package/dist/Components/{AppointmentCalendar/AppointmentCalendarProps.js → ResourceCalendar/ResourceCalendarProps.js}

@@ -1,8 +1,7 @@
 /**
  * Available calendar view modes.
  *
- * Frozen const + derived type, following the scoria
- * enum-as-const convention.
+ * Frozen const + derived type, following the scoria enum-as-const convention.
  */
 export const CalendarViewMode = {
     Day: 'day',

package/dist/Helpers/loaderDefaults.svelte.d.ts

@@ -2,7 +2,7 @@
  * Global fallback configuration for all loaders.
  *
  * Loaders rendered *internally* by components like {@link Table},
- * {@link DesktopModal} and {@link AppointmentCalendar} can't be handed a `name`
+ * {@link DesktopModal} and {@link ResourceCalendar} can't be handed a `name`
  * prop at the call site. So the host app sets {@link loaderDefaults.name} once —
  * typically in its root layout inside a browser `$effect` — and every loader
  * (including those internal ones) spells that name. An explicit `name` prop on a

package/dist/Helpers/loaderDefaults.svelte.js

@@ -2,7 +2,7 @@
  * Global fallback configuration for all loaders.
  *
  * Loaders rendered *internally* by components like {@link Table},
- * {@link DesktopModal} and {@link AppointmentCalendar} can't be handed a `name`
+ * {@link DesktopModal} and {@link ResourceCalendar} can't be handed a `name`
  * prop at the call site. So the host app sets {@link loaderDefaults.name} once —
  * typically in its root layout inside a browser `$effect` — and every loader
  * (including those internal ones) spells that name. An explicit `name` prop on a

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 export { default as AccordionGroup } from './Components/AccordionGroup.svelte';
-export { default as AppointmentCalendar } from './Components/AppointmentCalendar/AppointmentCalendar.svelte';
-export type { AppointmentCalendarProps, AppointmentMoveArgs, CalendarAppointment, CalendarDoor, CalendarViewMode, DoorAvailabilityWindow, DragSelection, } from './Components/AppointmentCalendar/AppointmentCalendarProps.js';
+export { default as ResourceCalendar } from './Components/ResourceCalendar/ResourceCalendar.svelte';
+export type { CalendarAvailabilityWindow, CalendarEvent, CalendarEventMoveArgs, CalendarRangeSelection, CalendarResource, CalendarViewMode, ResourceCalendarProps, } from './Components/ResourceCalendar/ResourceCalendarProps.js';
 export type { AccordionGroupButtonProps, AccordionGroupOption, } from './Components/AccordionGroupButtonProps.js';
 export type { AccordionGroupProps } from './Components/AccordionGroupProps.js';
 export { default as Action } from './Components/Action.svelte';

package/dist/index.js

@@ -1,5 +1,5 @@
 export { default as AccordionGroup } from './Components/AccordionGroup.svelte';
-export { default as AppointmentCalendar } from './Components/AppointmentCalendar/AppointmentCalendar.svelte';
+export { default as ResourceCalendar } from './Components/ResourceCalendar/ResourceCalendar.svelte';
 export { default as Action } from './Components/Action.svelte';
 export { default as AlertModal } from './Components/AlertModal.svelte';
 export { default as ContextWrapper } from './Components/Base/ContextWrapper.svelte';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@lavalogic/scoria",
   "description": "Svelte components used for the FloWMS Web Frontend",
-  "version": "0.40.21",
+  "version": "0.40.24",
   "publishConfig": {
     "access": "restricted"
   },

package/dist/Components/AppointmentCalendar/AppointmentCalendar.svelte.d.ts

@@ -1,4 +0,0 @@
-import type { AppointmentCalendarProps } from './AppointmentCalendarProps.js';
-declare const AppointmentCalendar: import("svelte").Component<AppointmentCalendarProps, {}, "">;
-type AppointmentCalendar = ReturnType<typeof AppointmentCalendar>;
-export default AppointmentCalendar;

package/dist/Components/AppointmentCalendar/AppointmentCalendarProps.d.ts

@@ -1,123 +0,0 @@
-import type { InputDateWithTime } from '../../Types/Internal/Misc.js';
-import type { SvelteDate } from 'svelte/reactivity';
-import type { Snippet } from 'svelte';
-/**
- * Available calendar view modes.
- *
- * Frozen const + derived type, following the scoria
- * enum-as-const convention.
- */
-export declare const CalendarViewMode: {
-    readonly Day: "day";
-    readonly Week: "week";
-    readonly Month: "month";
-};
-export type CalendarViewMode = (typeof CalendarViewMode)[keyof typeof CalendarViewMode];
-/**
- * A single appointment on the calendar.
- *
- * `dateFrom` and `dateTo` are branded with {@link InputDateWithTime} so
- * callers cannot accidentally pass a raw `string` that does not parse
- * as an ISO date-time. The branded values remain plain strings at
- * runtime; the component parses them into `Date` internally.
- */
-export interface CalendarAppointment {
-    readonly id: number;
-    readonly segmentId: number;
-    readonly dateFrom: InputDateWithTime;
-    readonly dateTo: InputDateWithTime;
-    readonly typeCode: string;
-    readonly label: string;
-    readonly sublabel?: string;
-    /** Optional booking reference shown on the appointment card. */
-    readonly reference?: string;
-}
-export interface CalendarDoor {
-    readonly id: number;
-    readonly name: string;
-}
-export interface DragSelection {
-    readonly doorId: number;
-    readonly doorName: string;
-    readonly dateFrom: Date;
-    readonly dateTo: Date;
-}
-/**
- * A span of available time on the currently displayed day, expressed in
- * minutes from midnight (`startMinutes` inclusive, `endMinutes`
- * exclusive). Consumed by {@link AppointmentCalendarProps.availability}
- * to shade out the times a door is not bookable.
- */
-export interface DoorAvailabilityWindow {
-    readonly startMinutes: number;
-    readonly endMinutes: number;
-}
-/**
- * Arguments passed to {@link AppointmentCalendarProps.onappointmentmove}.
- *
- * The previous five-positional-argument signature was easy to mix up
- * at the call site; this object form makes each field self-describing.
- */
-export interface AppointmentMoveArgs {
-    readonly appointment: CalendarAppointment;
-    readonly newDoorId: number;
-    readonly newDoorName: string;
-    readonly newDateFrom: Date;
-    readonly newDateTo: Date;
-}
-export interface AppointmentCalendarProps {
-    /** The doors (segments) to display as columns. */
-    doors: ReadonlyArray<CalendarDoor>;
-    /** The appointments to render on the calendar. */
-    appointments: ReadonlyArray<CalendarAppointment>;
-    /**
-     * The currently selected date.
-     *
-     * Accepts either a `Date` (which the component reads but does not
-     * mutate) or a `SvelteDate` for callers that want reactive
-     * day-rollover semantics. The component never writes to the value;
-     * use `ondatechange` to update it.
-     */
-    selectedDate: Date | SvelteDate;
-    /** The current view mode. */
-    viewMode: CalendarViewMode;
-    /** Called when the user changes the selected date. */
-    ondatechange: (date: Date) => void;
-    /** Called when the user changes the view mode. */
-    onviewmodechange: (mode: CalendarViewMode) => void;
-    /** Called when the user clicks and drags to create a new appointment. */
-    ondragcreate?: (selection: DragSelection) => void;
-    /** Called when the user clicks on an existing appointment. */
-    onappointmentclick?: (appointment: CalendarAppointment) => void;
-    /** Called when the user drags an existing appointment to a new door or time slot. */
-    onappointmentmove?: (args: AppointmentMoveArgs) => void;
-    /** The start hour for the day view grid (default: 0). */
-    startHour?: number;
-    /** The end hour for the day view grid (default: 24). */
-    endHour?: number;
-    /** The slot interval in minutes (default: 15). */
-    slotIntervalMinutes?: number;
-    /**
-     * Per-door availability for the currently displayed day, keyed by
-     * door (segment) id.
-     *
-     * When a door id is present, any slot whose start falls outside all
-     * of its {@link DoorAvailabilityWindow}s is shaded as unavailable and
-     * cannot be used to create or receive an appointment. A door absent
-     * from the map is treated as fully available (no shading); map an id
-     * to an empty array to mark a door wholly unavailable for the day.
-     *
-     * Omit the prop entirely to disable availability shading.
-     */
-    availability?: ReadonlyMap<number, ReadonlyArray<DoorAvailabilityWindow>>;
-    /**
-     * Hour of the day (0–23) to vertically centre when the day/week grid
-     * first appears (default: 12, i.e. midday). Set to `null` to keep the
-     * grid scrolled to the top.
-     */
-    centreHour?: number | null;
-    /** Whether the calendar is loading data. */
-    isLoading?: boolean;
-    /** Optional snippet for extra header content (e.g. buttons). */
-    headerExtra?: Snippet;
-}