@magicx-eng/ai-autocomplete-vanilla 0.24.0 → 0.25.0

package/dist/index.d.mts

@@ -1550,6 +1550,64 @@ declare function cursorIsAtEnd(root: HTMLElement): boolean;
  */
 declare function previousGraphemeBoundary(text: string, offset: number): number;
 
+/**
+ * A mouse wheel over the product strip scrolls it sideways.
+ *
+ * The strip is one row scrolling on the x axis with its scrollbar hidden
+ * (styles.css), so a mouse — whose wheel is vertical — had no way to reach the
+ * cards past the panel's edge. Trackpads and touch already scroll the row
+ * natively; this hands mouse users the same reach by turning a vertical wheel
+ * over the row into horizontal travel and keeping the page still.
+ *
+ * Shared by all three packages: vanilla binds it in `renderProductStrip`, and
+ * the React and Angular strips bind it on their own row element.
+ */
+/** The scroll metrics a wheel decision reads; a subset of `HTMLElement`. */
+interface ProductRowMetrics {
+    scrollLeft: number;
+    scrollWidth: number;
+    clientWidth: number;
+}
+/** The wheel fields a decision reads; a subset of `WheelEvent`. */
+interface ProductRowWheel {
+    deltaX: number;
+    deltaY: number;
+    deltaMode: number;
+    ctrlKey: boolean;
+}
+/**
+ * Pixels per line for a `deltaMode` of `DOM_DELTA_LINE`. Firefox reports about
+ * three lines a notch, so one notch lands near Chrome's 100px.
+ */
+declare const PRODUCT_ROW_PX_PER_LINE = 32;
+/**
+ * The row's next `scrollLeft` for a wheel turn over it, or `null` to leave the
+ * event to the browser, which already does the right thing when:
+ *
+ * - the gesture is sideways, or a diagonal whose horizontal part is at least
+ *   as large as its vertical one — a trackpad's horizontal delta scrolls the
+ *   row natively, and shift+wheel arrives as horizontal delta the same way. A
+ *   diagonal that is mostly vertical is still a wheel turn;
+ * - ctrl is held — that is a pinch zoom, not a scroll;
+ * - the row has nothing to scroll;
+ * - the turn is past either end. A row parked on its last card must not pin
+ *   the page under a resting pointer, so the turn falls through and the page
+ *   scrolls as it would anywhere else. `overscroll-behavior-x: contain` on the
+ *   row still stops a native horizontal fling from chaining out mid-row.
+ *
+ * Pure over the row's metrics so it can be tested without layout.
+ */
+declare function productRowWheelTarget(row: ProductRowMetrics, e: ProductRowWheel): number | null;
+/**
+ * Bind the wheel-to-sideways behaviour on a strip's row. Returns the detach.
+ *
+ * Registered non-passive on purpose: a wheel listener that cannot call
+ * `preventDefault` leaves the page scrolling under the row. React's `onWheel`
+ * prop is passive by default, which is why the React strip binds through a
+ * ref rather than the prop.
+ */
+declare function attachProductRowWheel(row: HTMLElement): () => void;
+
 /**
  * Scroll-to-caret for the editor's own scroll container.
  *
@@ -1917,4 +1975,4 @@ interface SubmitResultExtras {
  */
 declare function buildSubmitResult(text: string, completedParams: CompletedParamState[], skippedParams?: SkippedParamState[], extras?: SubmitResultExtras): AutocompleteResult;
 
-export { AIAutocomplete, type APIConfig, type APIKeyConfig, ATTRIBUTION_URL, type AccessTokenConfig, type AccessTokenResult, type AppearanceMode, type AutocompleteRequest, type AutocompleteResponse, type AutocompleteResult, type CompletedParam, type CompletedParamState, type CoreOptions, type CoreState, type CustomFieldsReport, DATE_RANGE_META_END, DATE_RANGE_META_START, type DateMonthView, type DateRange, type DateSelection, type ExpressedFilter, type FilterOp, type FormatType, type IdentifiedParam, type IdentifiedParamState, type InputItem, type LooseDateOptions, type MatchedItem, type MatchedItems, ModeController, OPTIONS_GRID_MOBILE_QUERY, OPTION_ENTER_DELAY_VAR, OPTION_ENTER_FADE_MS, OPTION_ENTER_RISE_MS, OPTION_ENTER_RISE_PX, OPTION_ENTER_STAGGER_MS, type OptionOverride, type OptionOverrides, type OptionsGridLayout, type OptionsGridPlan, PLACEHOLDER_FADE_OUT_MS, PLACEHOLDER_LEAVING_ATTR, PLACEHOLDER_SWAP_GAP_MS, PLACEHOLDER_TYPE_MS, PLACEHOLDER_WORD_PAUSE_MS, PRODUCT_PATH_PREFIX, type Product, type ProductsConfig, RANGE_SEPARATOR, type RecentlySuggested, type RenderMode, SCROLL_ARROW_ATTR, SCROLL_ARROW_BOTTOM_VAR, SCROLL_ARROW_CLASS, SCROLL_ARROW_FADE_MS, SCROLL_ARROW_LABEL, SCROLL_ARROW_SCROLL_IDLE_MS, SCROLL_ARROW_VISIBLE_ATTR, SKIPPED_PARAM_TEXT, type ScrollArrowArgs, type ScrollArrowController, type Segment, type SkippedParamState, type Store, type SubmitResultExtras, type Suggestion, type SuggestionOption, type TaskKind, WEEKDAY_LABELS, addMonths, attachScrollArrow, buildAttributionUrl, buildDateOptions, buildQuery, buildSubmitResult, cellDay, cellIso, computeOptionsGridLayout, createStore, cursorIsAtEnd, dateCellMarks, dateSelectionFor, extractPlainText, formatAbsoluteDate, formatDate, formatDateRange, getCursorOffset, getFooterHint, identifiedParamLabel, isCalendarFormat, isOptionsGridMobileViewport, isoDate, measureOptionsGrid, monthLabel, needsOptionsGridMeasurement, optionEnterDelayMs, optionLabel, optionsEntranceDurationMs, optionsGridTemplateColumns, parseDate, parseLooseDate, parseLooseDateRange, plainTextLength, planOptionsGrid, previousGraphemeBoundary, productFromMatchedItem, productsFromCustomFields, renderEditableContent, resolveFormatType, resolveIdentifiedDate, sanitizeOptionIconSvg, scrollCaretIntoView, selectedIsoFromText, selectedRangeFor, setCursorOffset, toWireIdentifiedParams, visibleDateRange, withSkippedParams };
+export { AIAutocomplete, type APIConfig, type APIKeyConfig, ATTRIBUTION_URL, type AccessTokenConfig, type AccessTokenResult, type AppearanceMode, type AutocompleteRequest, type AutocompleteResponse, type AutocompleteResult, type CompletedParam, type CompletedParamState, type CoreOptions, type CoreState, type CustomFieldsReport, DATE_RANGE_META_END, DATE_RANGE_META_START, type DateMonthView, type DateRange, type DateSelection, type ExpressedFilter, type FilterOp, type FormatType, type IdentifiedParam, type IdentifiedParamState, type InputItem, type LooseDateOptions, type MatchedItem, type MatchedItems, ModeController, OPTIONS_GRID_MOBILE_QUERY, OPTION_ENTER_DELAY_VAR, OPTION_ENTER_FADE_MS, OPTION_ENTER_RISE_MS, OPTION_ENTER_RISE_PX, OPTION_ENTER_STAGGER_MS, type OptionOverride, type OptionOverrides, type OptionsGridLayout, type OptionsGridPlan, PLACEHOLDER_FADE_OUT_MS, PLACEHOLDER_LEAVING_ATTR, PLACEHOLDER_SWAP_GAP_MS, PLACEHOLDER_TYPE_MS, PLACEHOLDER_WORD_PAUSE_MS, PRODUCT_PATH_PREFIX, PRODUCT_ROW_PX_PER_LINE, type Product, type ProductRowMetrics, type ProductRowWheel, type ProductsConfig, RANGE_SEPARATOR, type RecentlySuggested, type RenderMode, SCROLL_ARROW_ATTR, SCROLL_ARROW_BOTTOM_VAR, SCROLL_ARROW_CLASS, SCROLL_ARROW_FADE_MS, SCROLL_ARROW_LABEL, SCROLL_ARROW_SCROLL_IDLE_MS, SCROLL_ARROW_VISIBLE_ATTR, SKIPPED_PARAM_TEXT, type ScrollArrowArgs, type ScrollArrowController, type Segment, type SkippedParamState, type Store, type SubmitResultExtras, type Suggestion, type SuggestionOption, type TaskKind, WEEKDAY_LABELS, addMonths, attachProductRowWheel, attachScrollArrow, buildAttributionUrl, buildDateOptions, buildQuery, buildSubmitResult, cellDay, cellIso, computeOptionsGridLayout, createStore, cursorIsAtEnd, dateCellMarks, dateSelectionFor, extractPlainText, formatAbsoluteDate, formatDate, formatDateRange, getCursorOffset, getFooterHint, identifiedParamLabel, isCalendarFormat, isOptionsGridMobileViewport, isoDate, measureOptionsGrid, monthLabel, needsOptionsGridMeasurement, optionEnterDelayMs, optionLabel, optionsEntranceDurationMs, optionsGridTemplateColumns, parseDate, parseLooseDate, parseLooseDateRange, plainTextLength, planOptionsGrid, previousGraphemeBoundary, productFromMatchedItem, productRowWheelTarget, productsFromCustomFields, renderEditableContent, resolveFormatType, resolveIdentifiedDate, sanitizeOptionIconSvg, scrollCaretIntoView, selectedIsoFromText, selectedRangeFor, setCursorOffset, toWireIdentifiedParams, visibleDateRange, withSkippedParams };

package/dist/index.d.ts

@@ -1550,6 +1550,64 @@ declare function cursorIsAtEnd(root: HTMLElement): boolean;
  */
 declare function previousGraphemeBoundary(text: string, offset: number): number;
 
+/**
+ * A mouse wheel over the product strip scrolls it sideways.
+ *
+ * The strip is one row scrolling on the x axis with its scrollbar hidden
+ * (styles.css), so a mouse — whose wheel is vertical — had no way to reach the
+ * cards past the panel's edge. Trackpads and touch already scroll the row
+ * natively; this hands mouse users the same reach by turning a vertical wheel
+ * over the row into horizontal travel and keeping the page still.
+ *
+ * Shared by all three packages: vanilla binds it in `renderProductStrip`, and
+ * the React and Angular strips bind it on their own row element.
+ */
+/** The scroll metrics a wheel decision reads; a subset of `HTMLElement`. */
+interface ProductRowMetrics {
+    scrollLeft: number;
+    scrollWidth: number;
+    clientWidth: number;
+}
+/** The wheel fields a decision reads; a subset of `WheelEvent`. */
+interface ProductRowWheel {
+    deltaX: number;
+    deltaY: number;
+    deltaMode: number;
+    ctrlKey: boolean;
+}
+/**
+ * Pixels per line for a `deltaMode` of `DOM_DELTA_LINE`. Firefox reports about
+ * three lines a notch, so one notch lands near Chrome's 100px.
+ */
+declare const PRODUCT_ROW_PX_PER_LINE = 32;
+/**
+ * The row's next `scrollLeft` for a wheel turn over it, or `null` to leave the
+ * event to the browser, which already does the right thing when:
+ *
+ * - the gesture is sideways, or a diagonal whose horizontal part is at least
+ *   as large as its vertical one — a trackpad's horizontal delta scrolls the
+ *   row natively, and shift+wheel arrives as horizontal delta the same way. A
+ *   diagonal that is mostly vertical is still a wheel turn;
+ * - ctrl is held — that is a pinch zoom, not a scroll;
+ * - the row has nothing to scroll;
+ * - the turn is past either end. A row parked on its last card must not pin
+ *   the page under a resting pointer, so the turn falls through and the page
+ *   scrolls as it would anywhere else. `overscroll-behavior-x: contain` on the
+ *   row still stops a native horizontal fling from chaining out mid-row.
+ *
+ * Pure over the row's metrics so it can be tested without layout.
+ */
+declare function productRowWheelTarget(row: ProductRowMetrics, e: ProductRowWheel): number | null;
+/**
+ * Bind the wheel-to-sideways behaviour on a strip's row. Returns the detach.
+ *
+ * Registered non-passive on purpose: a wheel listener that cannot call
+ * `preventDefault` leaves the page scrolling under the row. React's `onWheel`
+ * prop is passive by default, which is why the React strip binds through a
+ * ref rather than the prop.
+ */
+declare function attachProductRowWheel(row: HTMLElement): () => void;
+
 /**
  * Scroll-to-caret for the editor's own scroll container.
  *
@@ -1917,4 +1975,4 @@ interface SubmitResultExtras {
  */
 declare function buildSubmitResult(text: string, completedParams: CompletedParamState[], skippedParams?: SkippedParamState[], extras?: SubmitResultExtras): AutocompleteResult;
 
-export { AIAutocomplete, type APIConfig, type APIKeyConfig, ATTRIBUTION_URL, type AccessTokenConfig, type AccessTokenResult, type AppearanceMode, type AutocompleteRequest, type AutocompleteResponse, type AutocompleteResult, type CompletedParam, type CompletedParamState, type CoreOptions, type CoreState, type CustomFieldsReport, DATE_RANGE_META_END, DATE_RANGE_META_START, type DateMonthView, type DateRange, type DateSelection, type ExpressedFilter, type FilterOp, type FormatType, type IdentifiedParam, type IdentifiedParamState, type InputItem, type LooseDateOptions, type MatchedItem, type MatchedItems, ModeController, OPTIONS_GRID_MOBILE_QUERY, OPTION_ENTER_DELAY_VAR, OPTION_ENTER_FADE_MS, OPTION_ENTER_RISE_MS, OPTION_ENTER_RISE_PX, OPTION_ENTER_STAGGER_MS, type OptionOverride, type OptionOverrides, type OptionsGridLayout, type OptionsGridPlan, PLACEHOLDER_FADE_OUT_MS, PLACEHOLDER_LEAVING_ATTR, PLACEHOLDER_SWAP_GAP_MS, PLACEHOLDER_TYPE_MS, PLACEHOLDER_WORD_PAUSE_MS, PRODUCT_PATH_PREFIX, type Product, type ProductsConfig, RANGE_SEPARATOR, type RecentlySuggested, type RenderMode, SCROLL_ARROW_ATTR, SCROLL_ARROW_BOTTOM_VAR, SCROLL_ARROW_CLASS, SCROLL_ARROW_FADE_MS, SCROLL_ARROW_LABEL, SCROLL_ARROW_SCROLL_IDLE_MS, SCROLL_ARROW_VISIBLE_ATTR, SKIPPED_PARAM_TEXT, type ScrollArrowArgs, type ScrollArrowController, type Segment, type SkippedParamState, type Store, type SubmitResultExtras, type Suggestion, type SuggestionOption, type TaskKind, WEEKDAY_LABELS, addMonths, attachScrollArrow, buildAttributionUrl, buildDateOptions, buildQuery, buildSubmitResult, cellDay, cellIso, computeOptionsGridLayout, createStore, cursorIsAtEnd, dateCellMarks, dateSelectionFor, extractPlainText, formatAbsoluteDate, formatDate, formatDateRange, getCursorOffset, getFooterHint, identifiedParamLabel, isCalendarFormat, isOptionsGridMobileViewport, isoDate, measureOptionsGrid, monthLabel, needsOptionsGridMeasurement, optionEnterDelayMs, optionLabel, optionsEntranceDurationMs, optionsGridTemplateColumns, parseDate, parseLooseDate, parseLooseDateRange, plainTextLength, planOptionsGrid, previousGraphemeBoundary, productFromMatchedItem, productsFromCustomFields, renderEditableContent, resolveFormatType, resolveIdentifiedDate, sanitizeOptionIconSvg, scrollCaretIntoView, selectedIsoFromText, selectedRangeFor, setCursorOffset, toWireIdentifiedParams, visibleDateRange, withSkippedParams };
+export { AIAutocomplete, type APIConfig, type APIKeyConfig, ATTRIBUTION_URL, type AccessTokenConfig, type AccessTokenResult, type AppearanceMode, type AutocompleteRequest, type AutocompleteResponse, type AutocompleteResult, type CompletedParam, type CompletedParamState, type CoreOptions, type CoreState, type CustomFieldsReport, DATE_RANGE_META_END, DATE_RANGE_META_START, type DateMonthView, type DateRange, type DateSelection, type ExpressedFilter, type FilterOp, type FormatType, type IdentifiedParam, type IdentifiedParamState, type InputItem, type LooseDateOptions, type MatchedItem, type MatchedItems, ModeController, OPTIONS_GRID_MOBILE_QUERY, OPTION_ENTER_DELAY_VAR, OPTION_ENTER_FADE_MS, OPTION_ENTER_RISE_MS, OPTION_ENTER_RISE_PX, OPTION_ENTER_STAGGER_MS, type OptionOverride, type OptionOverrides, type OptionsGridLayout, type OptionsGridPlan, PLACEHOLDER_FADE_OUT_MS, PLACEHOLDER_LEAVING_ATTR, PLACEHOLDER_SWAP_GAP_MS, PLACEHOLDER_TYPE_MS, PLACEHOLDER_WORD_PAUSE_MS, PRODUCT_PATH_PREFIX, PRODUCT_ROW_PX_PER_LINE, type Product, type ProductRowMetrics, type ProductRowWheel, type ProductsConfig, RANGE_SEPARATOR, type RecentlySuggested, type RenderMode, SCROLL_ARROW_ATTR, SCROLL_ARROW_BOTTOM_VAR, SCROLL_ARROW_CLASS, SCROLL_ARROW_FADE_MS, SCROLL_ARROW_LABEL, SCROLL_ARROW_SCROLL_IDLE_MS, SCROLL_ARROW_VISIBLE_ATTR, SKIPPED_PARAM_TEXT, type ScrollArrowArgs, type ScrollArrowController, type Segment, type SkippedParamState, type Store, type SubmitResultExtras, type Suggestion, type SuggestionOption, type TaskKind, WEEKDAY_LABELS, addMonths, attachProductRowWheel, attachScrollArrow, buildAttributionUrl, buildDateOptions, buildQuery, buildSubmitResult, cellDay, cellIso, computeOptionsGridLayout, createStore, cursorIsAtEnd, dateCellMarks, dateSelectionFor, extractPlainText, formatAbsoluteDate, formatDate, formatDateRange, getCursorOffset, getFooterHint, identifiedParamLabel, isCalendarFormat, isOptionsGridMobileViewport, isoDate, measureOptionsGrid, monthLabel, needsOptionsGridMeasurement, optionEnterDelayMs, optionLabel, optionsEntranceDurationMs, optionsGridTemplateColumns, parseDate, parseLooseDate, parseLooseDateRange, plainTextLength, planOptionsGrid, previousGraphemeBoundary, productFromMatchedItem, productRowWheelTarget, productsFromCustomFields, renderEditableContent, resolveFormatType, resolveIdentifiedDate, sanitizeOptionIconSvg, scrollCaretIntoView, selectedIsoFromText, selectedRangeFor, setCursorOffset, toWireIdentifiedParams, visibleDateRange, withSkippedParams };