@sprawlify/primitives 0.0.1

package/dist/machines/tour/index.d.cts

@@ -0,0 +1,206 @@
+import { n as AnatomyInstance } from "../../create-anatomy-BGQ8pv8J.cjs";
+import { p as Machine, u as EventObject, y as Service } from "../../types-DejIu60O.cjs";
+import { b as NormalizeProps, g as RequiredBy, r as DirectionProperty, t as CommonProperties, x as PropTypes } from "../../index-Bqw3r34-.cjs";
+import { i as waitForPromise, n as WaitForPromiseReturn, r as waitForElement, t as WaitForOptions } from "../../wait-for-CMjPsqWk.cjs";
+import { c as PointerDownOutsideEvent, i as InteractOutsideHandlers, n as FocusOutsideEvent, r as InteractOutsideEvent } from "../../index-C9-feK5c.cjs";
+import { c as Placement } from "../../types-DiIdKZ3K.cjs";
+
+//#region src/machines/tour/tour.anatomy.d.ts
+declare const anatomy: AnatomyInstance<"title" | "content" | "arrow" | "positioner" | "arrowTip" | "actionTrigger" | "description" | "closeTrigger" | "progressText" | "backdrop" | "spotlight">;
+//#endregion
+//#region src/machines/tour/utils/rect.d.ts
+interface Point {
+  x: number;
+  y: number;
+}
+interface Size {
+  width: number;
+  height: number;
+}
+interface Rect extends Point, Size {}
+//#endregion
+//#region src/machines/tour/tour.types.d.ts
+type StepEffectCleanup = VoidFunction | void;
+interface StepEffectArgs {
+  next: VoidFunction;
+  goto: (id: string) => void;
+  dismiss: VoidFunction;
+  show: VoidFunction;
+  update: (data: Partial<StepBaseDetails>) => void;
+  target?: (() => HTMLElement | null) | undefined;
+}
+type StepType = "tooltip" | "dialog" | "wait" | "floating";
+type StepActionType = "next" | "prev" | "dismiss" | "skip";
+type StepActionFn = (actionMap: StepActionMap) => void;
+type StepPlacement = Placement | "center";
+interface StepAction {
+  label: string;
+  action?: StepActionType | StepActionFn | undefined;
+  attrs?: Record<string, any> | undefined;
+}
+interface StepBaseDetails {
+  type?: StepType | undefined;
+  target?: (() => HTMLElement | null) | undefined;
+  title: any;
+  description: any;
+  placement?: StepPlacement | undefined;
+  offset?: {
+    mainAxis?: number | undefined;
+    crossAxis?: number | undefined;
+  } | undefined;
+  meta?: Record<string, any> | undefined;
+  backdrop?: boolean | undefined;
+  arrow?: boolean | undefined;
+  actions?: StepAction[] | undefined;
+}
+interface StepDetails extends StepBaseDetails {
+  id: string;
+  effect?: ((args: StepEffectArgs) => StepEffectCleanup) | undefined;
+}
+interface StepChangeDetails {
+  stepId: string | null;
+  stepIndex: number;
+  totalSteps: number;
+  complete: boolean;
+  progress: number;
+}
+interface StepsChangeDetails {
+  steps: StepDetails[];
+}
+type StepStatus = "idle" | "started" | "skipped" | "completed" | "dismissed" | "not-found";
+interface StepActionMap {
+  next: VoidFunction;
+  prev: VoidFunction;
+  dismiss: VoidFunction;
+  skip: VoidFunction;
+  goto: (id: string) => void;
+}
+interface StatusChangeDetails {
+  status: StepStatus;
+  stepId: string | null;
+  stepIndex: number;
+}
+interface ProgressTextDetails {
+  current: number;
+  total: number;
+}
+interface IntlTranslations {
+  progressText?: ((details: ProgressTextDetails) => string) | undefined;
+  nextStep?: string | undefined;
+  prevStep?: string | undefined;
+  close?: string | undefined;
+  skip?: string | undefined;
+}
+type ElementIds = Partial<{
+  content: string;
+  title: string;
+  description: string;
+  positioner: string;
+  backdrop: string;
+  arrow: string;
+}>;
+interface TourProps extends DirectionProperty, CommonProperties, InteractOutsideHandlers {
+  ids?: ElementIds | undefined;
+  steps?: StepDetails[] | undefined;
+  stepId?: string | null | undefined;
+  onStepChange?: ((details: StepChangeDetails) => void) | undefined;
+  onStepsChange?: ((details: StepsChangeDetails) => void) | undefined;
+  onStatusChange?: ((details: StatusChangeDetails) => void) | undefined;
+  closeOnInteractOutside?: boolean | undefined;
+  closeOnEscape?: boolean | undefined;
+  keyboardNavigation?: boolean | undefined;
+  preventInteraction?: boolean | undefined;
+  spotlightOffset?: Point | undefined;
+  spotlightRadius?: number | undefined;
+  translations?: IntlTranslations | undefined;
+}
+type PropsWithDefault = "spotlightOffset" | "spotlightRadius" | "translations" | "closeOnInteractOutside" | "closeOnEscape" | "keyboardNavigation" | "preventInteraction";
+interface PrivateContext {
+  targetRect: Rect;
+  currentPlacement?: StepPlacement | undefined;
+  boundarySize: Size;
+  resolvedTarget: HTMLElement | null;
+  stepId: string | null;
+  steps: StepDetails[];
+}
+interface Refs {
+  _targetCleanup?: VoidFunction | undefined;
+  _effectCleanup?: StepEffectCleanup | undefined;
+  _runningEffect?: boolean | undefined;
+  _prevTarget?: HTMLElement | null | undefined;
+}
+type ComputedContext = Readonly<{
+  step: StepDetails | null;
+  stepIndex: number;
+  hasNextStep: boolean;
+  hasPrevStep: boolean;
+  isFirstStep: boolean;
+  isLastStep: boolean;
+  progress: number;
+}>;
+interface TourSchema {
+  tag: "open" | "closed";
+  state: "tour.inactive" | "tour.active" | "step.waiting" | "target.resolving" | "target.scrolling";
+  props: RequiredBy<TourProps, PropsWithDefault>;
+  context: PrivateContext;
+  refs: Refs;
+  computed: ComputedContext;
+  event: EventObject;
+  action: string;
+  guard: string;
+  effect: string;
+}
+type TourService = Service<TourSchema>;
+type TourMachine = Machine<TourSchema>;
+interface StepActionTriggerProps {
+  action: StepAction;
+}
+interface TourApi<T extends PropTypes = PropTypes> {
+  open: boolean;
+  totalSteps: number;
+  stepIndex: number;
+  step: StepDetails | null;
+  hasNextStep: boolean;
+  hasPrevStep: boolean;
+  firstStep: boolean;
+  lastStep: boolean;
+  addStep: (step: StepDetails) => void;
+  removeStep: (id: string) => void;
+  updateStep: (id: string, stepOverrides: Partial<StepDetails>) => void;
+  setSteps: (steps: StepDetails[]) => void;
+  setStep: (id: string) => void;
+  start: (id?: string) => void;
+  isValidStep: (id: string) => boolean;
+  isCurrentStep: (id: string) => boolean;
+  next: VoidFunction;
+  prev: VoidFunction;
+  getProgressText: () => string;
+  getProgressPercent: () => number;
+  getBackdropProps: () => T["element"];
+  getSpotlightProps: () => T["element"];
+  getProgressTextProps: () => T["element"];
+  getPositionerProps: () => T["element"];
+  getArrowProps: () => T["element"];
+  getArrowTipProps: () => T["element"];
+  getContentProps: () => T["element"];
+  getTitleProps: () => T["element"];
+  getDescriptionProps: () => T["element"];
+  getCloseTriggerProps: () => T["button"];
+  getActionTriggerProps: (props: StepActionTriggerProps) => T["button"];
+}
+//#endregion
+//#region src/machines/tour/tour.connect.d.ts
+declare function connect<T extends PropTypes>(service: TourService, normalize: NormalizeProps<T>): TourApi<T>;
+//#endregion
+//#region src/machines/tour/tour.machine.d.ts
+declare const machine: Machine<TourSchema>;
+//#endregion
+//#region src/machines/tour/tour.props.d.ts
+declare const props: (keyof TourProps)[];
+declare const splitProps: <Props extends Partial<TourProps>>(props: Props) => [Partial<TourProps>, Omit<Props, keyof TourProps>];
+//#endregion
+//#region src/machines/tour/utils/wait.d.ts
+type EditableElement = HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement;
+declare function waitForElementValue(target: () => EditableElement | null, value: string, options: WaitForOptions): WaitForPromiseReturn<void>;
+//#endregion
+export { type TourApi as Api, type ElementIds, type FocusOutsideEvent, type InteractOutsideEvent, type IntlTranslations, type TourMachine as Machine, type Point, type PointerDownOutsideEvent, type ProgressTextDetails, type TourProps as Props, type TourService as Service, type StatusChangeDetails, type StepAction, type StepActionFn, type StepActionMap, type StepActionTriggerProps, type StepActionType, type StepBaseDetails, type StepChangeDetails, type StepDetails, type StepEffectArgs, type StepEffectCleanup, type StepPlacement, type StepStatus, type StepType, type StepsChangeDetails, type WaitForOptions as WaitOptions, anatomy, connect, machine, props, splitProps, waitForElement, waitForElementValue, waitForPromise };

package/dist/machines/tour/index.d.mts

@@ -0,0 +1,206 @@
+import { n as AnatomyInstance } from "../../create-anatomy-B3XYc-qG.mjs";
+import { p as Machine, u as EventObject, y as Service } from "../../types-DDTcG99l.mjs";
+import { b as NormalizeProps, g as RequiredBy, r as DirectionProperty, t as CommonProperties, x as PropTypes } from "../../index-C0MKXQmE.mjs";
+import { i as waitForPromise, n as WaitForPromiseReturn, r as waitForElement, t as WaitForOptions } from "../../wait-for-D2nkdD4z.mjs";
+import { c as PointerDownOutsideEvent, i as InteractOutsideHandlers, n as FocusOutsideEvent, r as InteractOutsideEvent } from "../../index-BkzYij2j.mjs";
+import { u as Placement } from "../../index-D96rs8B0.mjs";
+
+//#region src/machines/tour/tour.anatomy.d.ts
+declare const anatomy: AnatomyInstance<"title" | "content" | "arrow" | "positioner" | "arrowTip" | "actionTrigger" | "description" | "closeTrigger" | "progressText" | "backdrop" | "spotlight">;
+//#endregion
+//#region src/machines/tour/utils/rect.d.ts
+interface Point {
+  x: number;
+  y: number;
+}
+interface Size {
+  width: number;
+  height: number;
+}
+interface Rect extends Point, Size {}
+//#endregion
+//#region src/machines/tour/tour.types.d.ts
+type StepEffectCleanup = VoidFunction | void;
+interface StepEffectArgs {
+  next: VoidFunction;
+  goto: (id: string) => void;
+  dismiss: VoidFunction;
+  show: VoidFunction;
+  update: (data: Partial<StepBaseDetails>) => void;
+  target?: (() => HTMLElement | null) | undefined;
+}
+type StepType = "tooltip" | "dialog" | "wait" | "floating";
+type StepActionType = "next" | "prev" | "dismiss" | "skip";
+type StepActionFn = (actionMap: StepActionMap) => void;
+type StepPlacement = Placement | "center";
+interface StepAction {
+  label: string;
+  action?: StepActionType | StepActionFn | undefined;
+  attrs?: Record<string, any> | undefined;
+}
+interface StepBaseDetails {
+  type?: StepType | undefined;
+  target?: (() => HTMLElement | null) | undefined;
+  title: any;
+  description: any;
+  placement?: StepPlacement | undefined;
+  offset?: {
+    mainAxis?: number | undefined;
+    crossAxis?: number | undefined;
+  } | undefined;
+  meta?: Record<string, any> | undefined;
+  backdrop?: boolean | undefined;
+  arrow?: boolean | undefined;
+  actions?: StepAction[] | undefined;
+}
+interface StepDetails extends StepBaseDetails {
+  id: string;
+  effect?: ((args: StepEffectArgs) => StepEffectCleanup) | undefined;
+}
+interface StepChangeDetails {
+  stepId: string | null;
+  stepIndex: number;
+  totalSteps: number;
+  complete: boolean;
+  progress: number;
+}
+interface StepsChangeDetails {
+  steps: StepDetails[];
+}
+type StepStatus = "idle" | "started" | "skipped" | "completed" | "dismissed" | "not-found";
+interface StepActionMap {
+  next: VoidFunction;
+  prev: VoidFunction;
+  dismiss: VoidFunction;
+  skip: VoidFunction;
+  goto: (id: string) => void;
+}
+interface StatusChangeDetails {
+  status: StepStatus;
+  stepId: string | null;
+  stepIndex: number;
+}
+interface ProgressTextDetails {
+  current: number;
+  total: number;
+}
+interface IntlTranslations {
+  progressText?: ((details: ProgressTextDetails) => string) | undefined;
+  nextStep?: string | undefined;
+  prevStep?: string | undefined;
+  close?: string | undefined;
+  skip?: string | undefined;
+}
+type ElementIds = Partial<{
+  content: string;
+  title: string;
+  description: string;
+  positioner: string;
+  backdrop: string;
+  arrow: string;
+}>;
+interface TourProps extends DirectionProperty, CommonProperties, InteractOutsideHandlers {
+  ids?: ElementIds | undefined;
+  steps?: StepDetails[] | undefined;
+  stepId?: string | null | undefined;
+  onStepChange?: ((details: StepChangeDetails) => void) | undefined;
+  onStepsChange?: ((details: StepsChangeDetails) => void) | undefined;
+  onStatusChange?: ((details: StatusChangeDetails) => void) | undefined;
+  closeOnInteractOutside?: boolean | undefined;
+  closeOnEscape?: boolean | undefined;
+  keyboardNavigation?: boolean | undefined;
+  preventInteraction?: boolean | undefined;
+  spotlightOffset?: Point | undefined;
+  spotlightRadius?: number | undefined;
+  translations?: IntlTranslations | undefined;
+}
+type PropsWithDefault = "spotlightOffset" | "spotlightRadius" | "translations" | "closeOnInteractOutside" | "closeOnEscape" | "keyboardNavigation" | "preventInteraction";
+interface PrivateContext {
+  targetRect: Rect;
+  currentPlacement?: StepPlacement | undefined;
+  boundarySize: Size;
+  resolvedTarget: HTMLElement | null;
+  stepId: string | null;
+  steps: StepDetails[];
+}
+interface Refs {
+  _targetCleanup?: VoidFunction | undefined;
+  _effectCleanup?: StepEffectCleanup | undefined;
+  _runningEffect?: boolean | undefined;
+  _prevTarget?: HTMLElement | null | undefined;
+}
+type ComputedContext = Readonly<{
+  step: StepDetails | null;
+  stepIndex: number;
+  hasNextStep: boolean;
+  hasPrevStep: boolean;
+  isFirstStep: boolean;
+  isLastStep: boolean;
+  progress: number;
+}>;
+interface TourSchema {
+  tag: "open" | "closed";
+  state: "tour.inactive" | "tour.active" | "step.waiting" | "target.resolving" | "target.scrolling";
+  props: RequiredBy<TourProps, PropsWithDefault>;
+  context: PrivateContext;
+  refs: Refs;
+  computed: ComputedContext;
+  event: EventObject;
+  action: string;
+  guard: string;
+  effect: string;
+}
+type TourService = Service<TourSchema>;
+type TourMachine = Machine<TourSchema>;
+interface StepActionTriggerProps {
+  action: StepAction;
+}
+interface TourApi<T extends PropTypes = PropTypes> {
+  open: boolean;
+  totalSteps: number;
+  stepIndex: number;
+  step: StepDetails | null;
+  hasNextStep: boolean;
+  hasPrevStep: boolean;
+  firstStep: boolean;
+  lastStep: boolean;
+  addStep: (step: StepDetails) => void;
+  removeStep: (id: string) => void;
+  updateStep: (id: string, stepOverrides: Partial<StepDetails>) => void;
+  setSteps: (steps: StepDetails[]) => void;
+  setStep: (id: string) => void;
+  start: (id?: string) => void;
+  isValidStep: (id: string) => boolean;
+  isCurrentStep: (id: string) => boolean;
+  next: VoidFunction;
+  prev: VoidFunction;
+  getProgressText: () => string;
+  getProgressPercent: () => number;
+  getBackdropProps: () => T["element"];
+  getSpotlightProps: () => T["element"];
+  getProgressTextProps: () => T["element"];
+  getPositionerProps: () => T["element"];
+  getArrowProps: () => T["element"];
+  getArrowTipProps: () => T["element"];
+  getContentProps: () => T["element"];
+  getTitleProps: () => T["element"];
+  getDescriptionProps: () => T["element"];
+  getCloseTriggerProps: () => T["button"];
+  getActionTriggerProps: (props: StepActionTriggerProps) => T["button"];
+}
+//#endregion
+//#region src/machines/tour/tour.connect.d.ts
+declare function connect<T extends PropTypes>(service: TourService, normalize: NormalizeProps<T>): TourApi<T>;
+//#endregion
+//#region src/machines/tour/tour.machine.d.ts
+declare const machine: Machine<TourSchema>;
+//#endregion
+//#region src/machines/tour/tour.props.d.ts
+declare const props: (keyof TourProps)[];
+declare const splitProps: <Props extends Partial<TourProps>>(props: Props) => [Partial<TourProps>, Omit<Props, keyof TourProps>];
+//#endregion
+//#region src/machines/tour/utils/wait.d.ts
+type EditableElement = HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement;
+declare function waitForElementValue(target: () => EditableElement | null, value: string, options: WaitForOptions): WaitForPromiseReturn<void>;
+//#endregion
+export { type TourApi as Api, type ElementIds, type FocusOutsideEvent, type InteractOutsideEvent, type IntlTranslations, type TourMachine as Machine, type Point, type PointerDownOutsideEvent, type ProgressTextDetails, type TourProps as Props, type TourService as Service, type StatusChangeDetails, type StepAction, type StepActionFn, type StepActionMap, type StepActionTriggerProps, type StepActionType, type StepBaseDetails, type StepChangeDetails, type StepDetails, type StepEffectArgs, type StepEffectCleanup, type StepPlacement, type StepStatus, type StepType, type StepsChangeDetails, type WaitForOptions as WaitOptions, anatomy, connect, machine, props, splitProps, waitForElement, waitForElementValue, waitForPromise };