@svar-ui/calendar-store 2.6.0

package/dist/index.d.mts

@@ -0,0 +1,416 @@
+import { EventBus, Store, TDataConfig, TWritableCreator } from "@svar-ui/lib-state";
+
+//#region src/models/model.d.ts
+interface EventChunk {
+  id: EventID;
+  event: CalendarEvent;
+  start: Date;
+  end: Date;
+}
+declare abstract class ViewModel {
+  render?: string;
+  weekStartDay: number;
+  fmt: FormatFactory;
+  protected startDate: Date;
+  protected endDate: Date;
+  private cachedSections;
+  private _sectionOverrides?;
+  configure(sections: Record<string, any>): void;
+  abstract getSections(): Section[];
+  abstract rangeStart(date: Date): Date;
+  abstract addRange(date: Date, n: number): Date;
+  abstract getRangeLabel(): string;
+  setRange(date: Date): [Date, Date];
+  process(events: CalendarEvent[]): SectionResult[];
+  toPositionStart(sectionName: string, x: number, y: number, ev?: Partial<CalendarEvent>, snap?: boolean): Partial<CalendarEvent>;
+  toPositionEnd(sectionName: string, x: number, y: number, ev?: Partial<CalendarEvent>, snap?: boolean): Partial<CalendarEvent>;
+  private resolvePosition;
+  private processSection;
+  protected buildCells(_xScale: Scale, _yScale: Scale): GridCell[];
+  protected sortBeforeLayout(primitives: Primitive[], mode: string): void;
+  private getPrimaryAxis;
+  private splitEvent;
+  protected findUnitIndex(scale: Scale, event: CalendarEvent): number;
+  private findUnitForPosition;
+  protected mapToPrimitive(chunk: EventChunk, primaryUnit: {
+    position: number;
+    size: number;
+  }, secondaryScale: Scale, primaryAxis: "x" | "y"): Primitive | null;
+}
+//#endregion
+//#region src/events_store.d.ts
+declare class EventsStore implements IEventStore {
+  protected events: CalendarEvent[];
+  constructor(initialEvents?: CalendarEvent[]);
+  addEvent(event: Partial<CalendarEvent>): CalendarEvent;
+  updateEvent(id: EventID, updates: Partial<CalendarEvent>, _mode?: "single" | "following", _originalDate?: string): CalendarEvent | null;
+  removeEvent(id: EventID): boolean;
+  getEvent(id: EventID): CalendarEvent | undefined;
+  getEvents(start?: Date, end?: Date): CalendarEvent[];
+  clear(): void;
+  getCount(): number;
+}
+//#endregion
+//#region src/types.d.ts
+type Brandmark = {
+  text: string;
+  link?: string;
+  style: string;
+};
+type State = {
+  currentDate: Date;
+  currentView: string;
+  rangeLabel: string;
+  visibleDateRange: {
+    start: Date;
+    end: Date;
+  };
+  events: EventsStore;
+  viewData: any;
+  filters: Map<string, (obj: any) => boolean>;
+  editorData: CalendarEvent | null;
+  _view: ViewModel;
+};
+interface StoreActions {
+  ["navigate-to"]: {
+    date?: Date;
+    view?: string;
+  };
+  ["navigate-time"]: {
+    direction: "next" | "previous" | "now";
+  };
+  ["add-event"]: {
+    event: Partial<CalendarEvent>;
+    edit?: boolean;
+    id?: EventID;
+  };
+  ["update-event"]: {
+    id: EventID;
+    event: Partial<CalendarEvent>;
+    mode?: "single" | "following";
+    originalDate?: string;
+  };
+  ["delete-event"]: {
+    id: EventID;
+  };
+  ["select-event"]: {
+    id: EventID | null;
+  };
+  ["move-event"]: {
+    id: EventID;
+    x: number;
+    y: number;
+  };
+  ["filter-events"]: {
+    filter?: ((obj: any) => boolean) | null;
+    tag?: string;
+  };
+}
+type EventID = string | number;
+interface CalendarEvent {
+  id: EventID;
+  start: Date;
+  end: Date;
+  allDay?: boolean;
+  [key: string]: any;
+}
+interface ScaleUnit {
+  id: string | number;
+  label: string;
+  position: number;
+  size: number;
+  weekend?: boolean;
+  ui?: Record<string, any>;
+}
+interface Scale {
+  units: ScaleUnit[];
+  eventToPosition(event: CalendarEvent): {
+    start: number;
+    end: number;
+  };
+  contains(date: Date): boolean;
+  readonly count: number;
+  getHeaders(): ScaleUnit[][];
+  positionToValue(position: number): Date | string | number;
+}
+interface DateScaleConfig {
+  type: "date";
+  length: number;
+  step?: number;
+  snapStep?: number | false;
+  discrete?: boolean;
+  visible?: boolean;
+  format?: string;
+  ui?: Record<string, any>;
+}
+interface TimeScaleConfig {
+  type: "time";
+  startHour?: number;
+  endHour?: number;
+  step?: number;
+  snapStep?: number | false;
+  segments?: {
+    start: string;
+    end: string;
+    size?: number;
+    label?: string;
+    ui?: Record<string, any>;
+  }[];
+  visible?: boolean;
+  format?: string;
+  ui?: Record<string, any>;
+}
+type FormatFactory = (pattern: string) => (date: Date) => string;
+interface UnitScaleConfig {
+  type: "unit";
+  items: {
+    id: string | number;
+    label: string;
+  }[];
+  accessor: string | {
+    get: (event: CalendarEvent) => string | number;
+    set: (event: Partial<CalendarEvent>, id: string | number) => Partial<CalendarEvent>;
+  };
+  visible?: boolean;
+  ui?: Record<string, any>;
+}
+interface CombinedScaleConfig {
+  type: "combined";
+  outer: ScaleConfig;
+  inner: ScaleConfig;
+  visible?: boolean;
+}
+interface StackedScaleConfig {
+  type: "stacked";
+  levels: ScaleConfig[];
+  visible?: boolean;
+}
+type ScaleConfig = DateScaleConfig | TimeScaleConfig | UnitScaleConfig | CombinedScaleConfig | StackedScaleConfig;
+interface Primitive {
+  id: EventID;
+  event: CalendarEvent;
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+  isMultiDay?: boolean;
+  lane?: number;
+  totalLanes?: number;
+  slot?: number;
+  maxConcurrency?: number;
+}
+interface GridCell {
+  date: Date;
+  day: number;
+  inMonth: boolean;
+  today: boolean;
+  weekend: boolean;
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+}
+type SectionMode = "bars" | "boxes" | "grid" | "list" | "year";
+type BoxLayoutMode = "split" | "overlap";
+interface Section {
+  name: string;
+  mode: SectionMode;
+  xScale: ScaleConfig;
+  yScale: ScaleConfig;
+  primaryScale?: "x" | "y";
+  boxLayout?: BoxLayoutMode;
+  filter?: (event: CalendarEvent) => boolean;
+  size?: number | "content" | "content-optional";
+  ui?: Record<string, any>;
+}
+interface SectionResult {
+  name: string;
+  mode: SectionMode;
+  size: number | "content" | "content-optional";
+  primitives: Primitive[];
+  xHeaders: ScaleUnit[][] | null;
+  yHeaders: ScaleUnit[][] | null;
+  xVisible?: boolean;
+  yVisible?: boolean;
+  cells?: GridCell[];
+  ui?: Record<string, any>;
+}
+interface CellContext {
+  view: string;
+  section: string;
+  mode: SectionMode;
+  x: ScaleUnit | null;
+  y: ScaleUnit | null;
+  date: Date | null;
+}
+interface EventContext {
+  event: CalendarEvent;
+  view: string;
+  section: string;
+  mode: SectionMode;
+}
+type EventContentMode = "grid" | "bars" | "boxes" | "list" | "year-tooltip";
+type CellCss = (ctx: CellContext) => string;
+type EventCss = (ctx: EventContext) => string;
+interface IEventStore {
+  addEvent(event: Partial<CalendarEvent>): CalendarEvent;
+  updateEvent(id: EventID, updates: Partial<CalendarEvent>, mode?: "single" | "following", originalDate?: string): CalendarEvent | null;
+  removeEvent(id: EventID): boolean;
+  getEvent(id: EventID): CalendarEvent | undefined;
+  getEvents(start?: Date, end?: Date): CalendarEvent[];
+  clear(): void;
+  getCount(): number;
+}
+//#endregion
+//#region src/models/helpers/scales.d.ts
+declare class LinearScale implements Scale {
+  rangeStart: Date;
+  rangeEnd: Date;
+  stepMs: number;
+  snapStepMs: number | false;
+  unitCount: number;
+  units: ScaleUnit[];
+  discrete: boolean;
+  constructor(rangeStart: Date, rangeEnd: Date, unitCount: number, stepMs: number, format: (date: Date) => string, ui?: Record<string, any>, discrete?: boolean, snapStepMs?: number | false);
+  private formatId;
+  get count(): number;
+  eventToPosition(event: CalendarEvent): {
+    start: number;
+    end: number;
+  };
+  contains(date: Date): boolean;
+  positionToValue(position: number): Date;
+  getHeaders(): ScaleUnit[][];
+}
+declare class DiscreteScale implements Scale {
+  items: {
+    id: string | number;
+    label: string;
+  }[];
+  accessor: {
+    get: (event: CalendarEvent) => string | number;
+    set: (event: Partial<CalendarEvent>, id: string | number) => Partial<CalendarEvent>;
+  };
+  boxSize: number;
+  units: ScaleUnit[];
+  constructor(items: {
+    id: string | number;
+    label: string;
+  }[], accessor: {
+    get: (event: CalendarEvent) => string | number;
+    set: (event: Partial<CalendarEvent>, id: string | number) => Partial<CalendarEvent>;
+  }, ui?: Record<string, any>);
+  get count(): number;
+  eventToPosition(event: CalendarEvent): {
+    start: number;
+    end: number;
+  };
+  contains(): boolean;
+  positionToValue(position: number): string | number;
+  getHeaders(): ScaleUnit[][];
+}
+declare function createScale(config: ScaleConfig, startDate: Date, fmt?: FormatFactory): Scale;
+//#endregion
+//#region src/models/helpers/layout.d.ts
+interface BarLayoutResult {
+  primitives: Primitive[];
+  totalLanes: number;
+}
+interface BoxLayoutResult {
+  primitives: Primitive[];
+}
+declare function layoutBars(primitives: Primitive[]): BarLayoutResult;
+declare function layoutBoxes(primitives: Primitive[]): BoxLayoutResult;
+//#endregion
+//#region src/models/helpers/filters.d.ts
+declare function isMultiDay(event: CalendarEvent): boolean;
+//#endregion
+//#region src/models/week_view.d.ts
+declare class WeekViewModel extends ViewModel {
+  getSections(): Section[];
+  getRangeLabel(): string;
+  rangeStart(date: Date): Date;
+  addRange(date: Date, n: number): Date;
+}
+//#endregion
+//#region src/models/day_view.d.ts
+declare class DayViewModel extends ViewModel {
+  getSections(): Section[];
+  getRangeLabel(): string;
+  rangeStart(date: Date): Date;
+  addRange(date: Date, n: number): Date;
+}
+//#endregion
+//#region src/models/month_view.d.ts
+declare class MonthViewModel extends ViewModel {
+  snapToCell: boolean;
+  getSections(): Section[];
+  getRangeLabel(): string;
+  setRange(date: Date): [Date, Date];
+  rangeStart(date: Date): Date;
+  addRange(date: Date, n: number): Date;
+  protected sortBeforeLayout(primitives: Primitive[], _mode: string): void;
+  protected mapToPrimitive(chunk: EventChunk, primaryUnit: {
+    position: number;
+    size: number;
+  }, secondaryScale: Scale, primaryAxis: "x" | "y"): Primitive | null;
+  protected buildCells(xScale: Scale, yScale: Scale): GridCell[];
+  private getTargetMonth;
+  private getWeekCount;
+}
+//#endregion
+//#region src/registry.d.ts
+type ViewModelConstructor = new () => ViewModel;
+type ViewConfig = string | {
+  id: string;
+  label?: string;
+  sections?: Record<string, any>;
+};
+declare function registerCalendarView(id: string, viewClass: ViewModelConstructor): void;
+//#endregion
+//#region src/constants.d.ts
+declare function getMenuOptions(): {
+  id: string;
+  text: string;
+  icon: string;
+}[];
+type ToolbarItem = {
+  id?: string;
+  comp: string;
+  value?: any;
+  options?: {
+    id: string;
+    label: string;
+  }[];
+  [key: string]: any;
+};
+declare function getToolbarItems(): ToolbarItem[];
+//#endregion
+//#region src/calendar_store.d.ts
+declare class CalendarStore extends Store<State> {
+  in: EventBus<StoreActions, keyof StoreActions>;
+  private _router;
+  private _views;
+  private _weekStartDay;
+  private _dateFormat;
+  constructor(w: TWritableCreator, options?: {
+    recurring?: boolean;
+    weekStart?: number;
+    dateFormat?: FormatFactory;
+  });
+  configureViews(views?: ViewConfig[]): void;
+  init(state: Partial<State>): void;
+  private applyViewConfig;
+  getView(name: string): any;
+  getEvents(start?: Date, end?: Date): CalendarEvent[];
+  getEvent(id: string | number): CalendarEvent | undefined;
+  getBrandmark(): Brandmark | null;
+  setState(state: Partial<State>, ctx?: TDataConfig): {
+    [key: string]: (() => void) | null;
+  };
+}
+//#endregion
+//#region src/index.d.ts
+declare const version: string;
+//#endregion
+export { type Brandmark, type CalendarEvent, CalendarStore, type CellContext, type CellCss, type CombinedScaleConfig, type DateScaleConfig, DayViewModel, DiscreteScale, type EventContentMode, type EventContext, type EventCss, type EventID, EventsStore, type FormatFactory, type GridCell, type IEventStore, LinearScale, MonthViewModel, type Primitive, type Scale, type ScaleConfig, type ScaleUnit, type Section, type SectionMode, type SectionResult, type StackedScaleConfig, type State, type StoreActions, type TimeScaleConfig, type ToolbarItem, type UnitScaleConfig, type ViewConfig, ViewModel, WeekViewModel, createScale, getMenuOptions, getToolbarItems, isMultiDay, layoutBars, layoutBoxes, registerCalendarView, version };